This method returns information about one or more ad campaigns being run by one target advertiser. Results can be filtered by using query parameters.
http://api.adbeat.com/v3/{api-key}/campaignMetrics/{advertiserId}
| Parameter Name | Meaning | Default Value | Notes |
|---|---|---|---|
| campaignId | campaign filter | (no filtering) | Restrict results to just one of the target advertiser's campaigns |
| countryId | country filter | (no filtering) | Currently, only &countryId=us is supported. (See countries) |
| platformId | platform filter | (no filtering) | e.g. desktop (See platforms) To specify multiple values, separate them by commas (e.g. iPhone,iPad) Currently only desktop is supported for a non-us countryId. Use &platformId=mobile to specify all mobile devices (i.e. android, iphone, ipad, androidtablet) |
| networkId | network filter | (no filtering) | Restrict search to one or more networks. (See networks). To specify multiple values, separate them by commas (e.g. adblade,google). Use all to return aggregated results across all networks. |
| publisherId | publisher filter | (no filtering) | Restrict search to just one publisher. Must use publisher’s (or channel’s) domain name. Use all to return aggregated results across all publishers. |
| categoryId | category filter | (no filtering) | Restrict search to advertisers that fall somewhere in the specified category path or below. For example: &categoryId=/finance/personal finance will return advertisers categorized as "/finance/personal finance" along with advertisers that belong to any subcategories like "/finance/personal finance/insurance", "/finance/personal finance/insurance/homeowners insurance", "/finance/personal finance/debt management", etc. |
| firstSeen | first seen filter | (no filtering) | Restrict search to advertisers whose ads were first seen (over the past 2 years) on the specified date or within the specified date range. Maximum date range span is 8 days. (See date and date range format) |
| sortBy | sorting field | adMetric | Other options: firstSeen, lastSeen, daysSeen |
| sortOrder | sorting order | desc | Other options: asc |
| adMetricId | Format for ad metric data | adImpact | Other options: adSpend |
| isChannel | channel vs. publisher filter | (no filtering) | Restrict search to either channels true or publishers (any other value). |
| publisherPld | publisher PLD filter | (no filtering) | Restrict search to just one publisher "paid-level domain" (i.e., return hits matching this publisher and all of its channels). Must user publisher's domain name. |
| numAdMetricDays | Number of daily ad metrics to return | 0 | Includes this many days up to and including the latest data. Maximum 730. |
| maxPlacementUrls | Maximum number of placement URLs to return | 0 | Return up to this many placement URLs for each hit. Maximum 100. Note: Each placementURL returned will cost 1 API unit. |
| rows | Number of results to return | 10 | Maximum 1000. (Maximum sum of &start + &rows is 2000) |
| start | Index of first result to return | 0 | Use start=N (where N > 0) to page through results by making repeated requests. (Maximum sum of &start + &rows is 2000) |
| fields | fields filter | (no filtering) | Restrict which fields get returned. e.g. &fields=advertiserId would return just one of the available fields. &fields=advertiserId,publisherId would return just two of the available fields. |
| Field Name | Example | Notes |
|---|---|---|
| countryId | us | See countries |
| platformId | desktop | See platforms |
| publisherPld | about.com | "Paid-level domain" of this channel. Only present if &isChannel is also true. |
| hasChannels | true | Contains true if hit is a publisher that has has been divided into channels. |
| isChannel | true | Contains true if hit is for a channel within a publisher. |
| isSuperChannel | true | Contains true if hit is for a "super channel" within a publisher having so many subdomains that each super channel refers to a portion of these subdomains. Only present if isChannel is also true. |
| networkId | See networks | |
| publisherId | huffingtonpost.com | Publisher domain name. (See Historical Data for how we handle older data) |
| categoryIds |
[{
"categoryId": "/technology and computing/internet technology/email",
"score": 1.0E-6
}, {
"categoryId": "/technology and computing/internet technology/web search",
"score": 1.0E-6
}, {
"categoryId": "/technology and computing/internet technology/social network",
"score": 1.0E-6
}]
|
Category IDs for this advertiser. Only returned when &platformId=all, &publisherId=all, and &networkId=all are set. Not returned for &advertiserId=all |
| firstSeen | 2012-12-05 | Date on which advertiser’s first ad was published (over the past 2 years) Only present when &firstSeen is a date range. (See Response Format) |
| lastSeen | 2012-12-10 | Date on which advertiser’s most recent ad was published |
| daysSeen | 3 | Number of days on which at least one of the advertiser’s ads was seen over the past two years |
| adCountsUnique |
{
"30": 44,
"90": 59,
"180": 65,
"365": 67,
"730": 78
}
|
Unique ad count totals for the most recent 30,90,180,365 and 730 days. |
| campaignName |
"campaigns": {
"campaignName": "77-year-old trader: How I made a lot of money",
"campaignId": "d2a5b9"
}
|
Unique only among a single advertiser's campaigns. (This field is part of the "campaigns" array as shown.) |
| campaignId |
"campaigns": {
"campaignName": "77-year-old trader: How I made a lot of money",
"campaignId": "d2a5b9"
}
|
Hash of campaign name. (This field is part of the "campaigns" array as shown.) |
| publisherCountsUnique |
{
"30": 5,
"90": 7,
"180": 8,
"365": 10,
"730": 12
}
|
Unique publisher count totals for the most recent 30,90,180,365 and 730 days. |
| adImpacts |
{
"30": 504512,
"90": 529024,
"180": 529024,
"365": 529024,
"730": 529024
}
|
Ad impact totals for the most recent 30,90,180,365 and 730 days. Only present for &adMetricId=adImpact. |
| adSpends |
{
"30": 12613,
"90": 13226,
"180": 13226,
"365": 13226,
"730": 13226
}
|
Ad spend totals (in US dollars) for the most recent 30,90,180,365 and 730 days. Only present for &adMetricId=adSpend. |
| adTypeImpacts |
{
"text": 129024,
"image": 100000,
"textimg": 50000,
"flash": 250000
}
|
Ad impact totals over the past 730 days by ad type. Only present for &adMetricId=adImpact. |
| adTypeSpends |
{
"text": 3226,
"image": 2000,
"textimg": 1000,
"flash": 7000
}
|
Ad spend totals over the past 730 days by ad type. Only present for &adMetricId=adSpend. |
| adSizeImpacts |
{
"300x250": 129024,
"728x90": 100000,
"300x600": 50000,
"200x200": 250000
}
|
Ad impact totals over the past 730 days by ad image size. Only present for &adMetricId=adImpact. |
| adSizeSpends |
{
"300x250": 3226,
"728x90": 2000,
"300x600": 1000,
"200x200": 7000
}
|
Ad send totals over the past 730 days by ad image size. Only present for &adMetricId=adSpend. |
| adImpactsDaily |
{
"firstDate": "2012-12-01",
"adImpacts": [
10405,
9887,
12543,
11332,
12908,
15673,
10943,
13763,
10952,
11722
]
}
|
Ad impact totals for each day up to and including the latest data. Only present for &adMetricId=adImpact and when &numAdMetricDays is also provided. |
| adSpendsDaily |
{
"firstDate": "2012-12-01",
"adSpends": [
260,
247,
314,
283,
323,
392,
274,
344,
274,
293
]
}
|
Ad spend totals (in US dollars) for each day up to and including the latest data. Only present for &adMetricId=adSpend and when &numAdMetricDays is also provided. |
| adTrends |
{
"30": -75,
"90": 150
}
|
See adTrends Values |
| adCountsUniqueDaily |
{
"firstDate": "2012-12-01",
"adCountsUnique": {
104, 98, 125, 113, 129, 156, 109, 137, 109, 117
}
}
|
Unique ad count totals for each day up to and including the target date of the indexes. Only present when &numAdMetricDays is provided. |
| publisherCountsUniqueDaily |
{
"firstDate": "2012-12-01",
"publisherCountsUnique": {
10, 9, 12, 11, 12, 15, 10, 13, 10, 11
}
}
|
Unique publisher count totals for each day up to and including the target date of the indexes. Only present when &numAdMetricDays is provided. Note that unless &publisherId=all is also provided, the results will not be particularly useful (i.e., when each hit refers to just one specific publisher, the publisherCountsUnique field will contain date-specific elements of 0 or 1). |
| placementUrls |
[{
"url": "http://www.huffingtonpost.com/events.html",
"adImpact": 529024
}, {
"url": "http://www.huffingtonpost.com/media.html",
"adImpact": 504512
}]
|
Each URL is returned with its ad impact/spend totals for the date range matching &sortBy (default 730 days). Only present for &maxPlacementUrls > 0 (and neither &advertiserId nor &publisherId can be "all"). If &adMetricId=adSpend, then the adImpact field will be replaced with adSpend. Note: Each placementURL returned will cost 1 API unit. |
| apiUnits | 150 | The number of API units consumed by this request. |
cnn.com is running on the outbrain network (sorted by "ad impact") do this:http://api.adbeat.com/v3/{api-key}/campaignMetrics/cnn.com?networkid=outbrain
{
"statusCode": 200,
"numHits": 2003,
"hits": [{
"countryId": "us",
"lastSeen": "2016-04-12",
"publisherId": "thepetitionsite.com",
"adCountsUnique": {
"365": 6,
"180": 6,
"30": 0,
"90": 0,
"730": 6
},
"campaigns": {
"campaignName": "77-year-old trader: How I made a lot of money",
"campaignId": "d2a5b9"
},
"hasChannels": false,
"daysSeen": 40,
"platformId": "desktop",
"adSizeImpacts": {},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 135520,
"180": 135520,
"30": 0,
"90": 0,
"730": 135520
},
"adTypeImpacts": {
"text": 135512
},
"firstSeen": "2016-02-12"
}, {
"countryId": "us",
"lastSeen": "2016-03-21",
"publisherId": "go.com",
"adCountsUnique": {
"365": 2,
"180": 2,
"30": 0,
"90": 0,
"730": 2
},
"campaigns": {
"campaignName": "Sharapova suspension: Doping agency's unfair game of 'gotcha'?",
"campaignId": "2b625b"
},
"hasChannels": true,
"daysSeen": 4,
"platformId": "desktop",
"adSizeImpacts": {
"other": 128219
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 128208,
"180": 128208,
"30": 0,
"90": 0,
"730": 128208
},
"adTypeImpacts": {
"textimg": 128219
},
"firstSeen": "2016-03-18"
}, {
"countryId": "us",
"lastSeen": "2016-03-21",
"publisherId": "espn.go.com",
"publisherPld": "go.com",
"adCountsUnique": {
"365": 2,
"180": 2,
"30": 0,
"90": 0,
"730": 2
},
"campaigns": {
"campaignName": "Sharapova suspension: Doping agency's unfair game of 'gotcha'?",
"campaignId": "2b625b"
},
"hasChannels": false,
"daysSeen": 4,
"platformId": "desktop",
"isSuperChannel": false,
"adSizeImpacts": {
"other": 128219
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": true,
"adImpacts": {
"365": 128208,
"180": 128208,
"30": 0,
"90": 0,
"730": 128208
},
"adTypeImpacts": {
"textimg": 128219
},
"firstSeen": "2016-03-18"
}, {
"countryId": "us",
"lastSeen": "2016-03-21",
"publisherId": "espn.go.com",
"publisherPld": "go.com",
"adCountsUnique": {
"365": 2,
"180": 2,
"30": 0,
"90": 0,
"730": 2
},
"campaigns": {
"campaignName": "Maria Sharapova: Kremlin fights back",
"campaignId": "44ecc5"
},
"hasChannels": false,
"daysSeen": 4,
"platformId": "desktop",
"isSuperChannel": false,
"adSizeImpacts": {
"other": 119989
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": true,
"adImpacts": {
"365": 119984,
"180": 119984,
"30": 0,
"90": 0,
"730": 119984
},
"adTypeImpacts": {
"textimg": 119989
},
"firstSeen": "2016-03-18"
}, {
"countryId": "us",
"lastSeen": "2016-03-21",
"publisherId": "go.com",
"adCountsUnique": {
"365": 2,
"180": 2,
"30": 0,
"90": 0,
"730": 2
},
"campaigns": {
"campaignName": "Maria Sharapova: Kremlin fights back",
"campaignId": "44ecc5"
},
"hasChannels": true,
"daysSeen": 4,
"platformId": "desktop",
"adSizeImpacts": {
"other": 119989
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 119984,
"180": 119984,
"30": 0,
"90": 0,
"730": 119984
},
"adTypeImpacts": {
"textimg": 119989
},
"firstSeen": "2016-03-18"
}, {
"countryId": "us",
"lastSeen": "2016-02-28",
"publisherId": "chron.com",
"adCountsUnique": {
"365": 3,
"180": 3,
"30": 0,
"90": 0,
"730": 3
},
"campaigns": {
"campaignName": "77-year-old trader: How I made a lot of money",
"campaignId": "d2a5b9"
},
"hasChannels": true,
"daysSeen": 5,
"platformId": "desktop",
"adSizeImpacts": {
"other": 51926
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 71824,
"180": 71824,
"30": 0,
"90": 0,
"730": 71824
},
"adTypeImpacts": {
"text": 19904,
"textimg": 51926
},
"firstSeen": "2016-02-18"
}, {
"countryId": "us",
"lastSeen": "2016-03-28",
"publisherId": "chron.com",
"adCountsUnique": {
"365": 9,
"180": 9,
"30": 0,
"90": 0,
"730": 9
},
"campaigns": {
"campaignName": "Singapore's best street food",
"campaignId": "77710f"
},
"hasChannels": true,
"daysSeen": 13,
"platformId": "desktop",
"adSizeImpacts": {
"other": 46155
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 58328,
"180": 58328,
"30": 0,
"90": 0,
"730": 58328
},
"adTypeImpacts": {
"text": 12173,
"textimg": 46155
},
"firstSeen": "2016-03-15"
}, {
"countryId": "us",
"lastSeen": "2016-03-28",
"publisherId": "sfgate.com",
"adCountsUnique": {
"365": 55,
"180": 55,
"30": 0,
"90": 0,
"730": 55
},
"campaigns": {
"campaignName": "Singapore's best street food",
"campaignId": "77710f"
},
"hasChannels": true,
"daysSeen": 14,
"platformId": "desktop",
"adSizeImpacts": {
"other": 43007
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 55560,
"180": 55560,
"30": 0,
"90": 0,
"730": 55560
},
"adTypeImpacts": {
"text": 12553,
"textimg": 43007
},
"firstSeen": "2016-03-15"
}, {
"countryId": "us",
"lastSeen": "2016-03-21",
"publisherId": "espn.go.com",
"publisherPld": "go.com",
"adCountsUnique": {
"365": 2,
"180": 2,
"30": 0,
"90": 0,
"730": 2
},
"campaigns": {
"campaignName": "Maria Sharapova: Tennis star suspended by UN",
"campaignId": "3cf553"
},
"hasChannels": false,
"daysSeen": 4,
"platformId": "desktop",
"isSuperChannel": false,
"adSizeImpacts": {
"other": 40914
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": true,
"adImpacts": {
"365": 40920,
"180": 40920,
"30": 0,
"90": 0,
"730": 40920
},
"adTypeImpacts": {
"textimg": 40914
},
"firstSeen": "2016-03-18"
}, {
"countryId": "us",
"lastSeen": "2016-03-21",
"publisherId": "go.com",
"adCountsUnique": {
"365": 2,
"180": 2,
"30": 0,
"90": 0,
"730": 2
},
"campaigns": {
"campaignName": "Maria Sharapova: Tennis star suspended by UN",
"campaignId": "3cf553"
},
"hasChannels": true,
"daysSeen": 4,
"platformId": "desktop",
"adSizeImpacts": {
"other": 40914
},
"adTrends": {
"30": 0,
"90": 0
},
"categoryIds": [],
"publisherCountsUnique": {
"365": 1,
"180": 1,
"30": 0,
"90": 0,
"730": 1
},
"isChannel": false,
"adImpacts": {
"365": 40920,
"180": 40920,
"30": 0,
"90": 0,
"730": 40920
},
"adTypeImpacts": {
"textimg": 40914
},
"firstSeen": "2016-03-18"
}],
"apiUnits": 150,
"statusMsg": "successful campaignMetrics/cnn.com request",
"requestParameters": {
"networkid": "outbrain",
"advertiserId": "cnn.com"
},
"handler": "campaignMetrics"
}