Amplify APIReference
Retrieve performance statistics for all marketer campaigns by section
GET
/reports/marketers/{id}/campaigns/sectionsAuthorization
obToken OB-TOKEN-V1<token>
Token obtained from the Obtain a token endpoint or the Amplify API token page. Valid for 30 days.
In: header
Path Parameters
id*string
Marketer id
Query Parameters
from?string
Start day Date
to?string
End day Date
campaignId?string
Limit to data of the campaign with the given ID / IDs.
limit?number
Number of results to return in this request for each campaign. default is 10.
offset?number
Result number to start this response at. zero based. Used with limit for pagination. default is 0.
includeArchivedCampaigns?string
Include data of archived campaigns, default false.
includeConversionDetails?string
Include metrics of conversion pixels, default false.
conversionsByClickDate?string
Report conversion metrics by click or conversion date, default false (report by conversion date).
enabledCampaignsOnly?string
Include data of active campaigns only (data of inactive campaigns will not be shown). Relevant only when requesting all campaigns
Response Body
application/json
curl -X GET "https://example.com/reports/marketers/abf4b02153ee75f3cadc4fc128ab0419ab/campaigns/sections?from=2015-12-22&to=2016-01-20&campaignId=e75f3cadc4fc128ab0419ababf4b02153e%2C+0069fc0fe9598f99b4c528f0881cd74b4b&limit=10&offset=3&includeArchivedCampaigns=true&includeConversionDetails=false&conversionsByClickDate=true&enabledCampaignsOnly=true"{ "campaignResults": [ { "campaignId": "000676cb2c84f64c5152822eb27af11d7e", "results": [ { "metadata": { "id": "008a88410d1345570c09e0e58e07dbf859", "name": "Microsoft One Promo - EN-CA - MSN", "publisherId": "006c8be9b36b8208ac4ce41072cc5f59e3", "publisherName": "Microsoft One Promo Canada_EN (Microsoft One Promo)", "url": "http://www.microsoft.onepromo.com/en-ca/msn/", "publisherUrl": "https://www.microsoft.com", "isOen": false }, "metrics": { "impressions": 93744, "clicks": 177, "totalConversions": 1, "conversions": 1, "viewConversions": 0, "spend": 38.77, "ecpc": 0.22, "ctr": 0.19, "conversionRate": 0.56, "viewConversionRate": 0, "cpa": 38.77, "totalCpa": 38.77, "totalValue": 4, "totalSumValue": 4, "sumValue": 4, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.8, "totalRoas": 0.8, "conversionMetrics": [ { "name": "Install", "totalConversions": 1, "conversions": 1, "viewConversions": 0, "conversionRate": 0.56, "viewConversionRate": 0, "totalCpa": 38.77, "cpa": 38.77, "totalValue": 4, "totalSumValue": 4, "sumValue": 4, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5 }, { "name": "ArticleEngagement", "totalConversions": 2, "conversions": 0, "viewConversions": 2, "conversionRate": 0, "viewConversionRate": 0, "totalCpa": 19.39, "cpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } ] } }, { "metadata": { "id": "00ff7afb321062ac4221d0c6c935ec7788", "name": "CNN Edition - Politics", "publisherId": "007d5bdae84ea9f865307ba5e95aa29dda", "publisherName": "CNN Edition (Turner International)", "url": "http://edition.cnn.com/politics/", "publisherUrl": "http://edition.cnn.com", "isOen": false }, "metrics": { "impressions": 83947, "clicks": 109, "totalConversions": 8, "conversions": 8, "viewConversions": 0, "spend": 23.77, "ecpc": 0.22, "ctr": 0.13, "conversionRate": 7.34, "viewConversionRate": 0, "cpa": 2.97, "totalCpa": 2.97, "totalValue": 32, "totalSumValue": 32, "sumValue": 32, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5, "conversionMetrics": [ { "name": "Install", "totalConversions": 8, "conversions": 8, "viewConversions": 0, "conversionRate": 7.34, "viewConversionRate": 0, "totalCpa": 2.97, "cpa": 2.97, "totalValue": 32, "totalSumValue": 32, "sumValue": 32, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5 }, { "name": "ArticleEngagement", "totalConversions": 6, "conversions": 6, "viewConversions": 0, "conversionRate": 5.5, "viewConversionRate": 0, "totalCpa": 3.96, "cpa": 3.96, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 }, { "name": "MobileSignup", "totalConversions": 1, "conversions": 1, "viewConversions": 0, "conversionRate": 0.92, "viewConversionRate": 0, "totalCpa": 23.77, "cpa": 23.77, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } ] } } ], "totalResults": 3781 }, { "campaignId": "008cf1e9b1e1394b15f24aec493d2f861c", "results": [ { "metadata": { "id": "00553b4e7de013f31cf17b98e6e5c9a475", "name": "TIME", "publisherId": "006f78b958c0719b007fc916075c4d3449", "publisherName": "Time Magazine (Meredith)", "url": "http://www.time.com/", "publisherUrl": "https://time.com", "isOen": false }, "metrics": { "impressions": 295134, "clicks": 1036, "totalConversions": 37, "conversions": 37, "viewConversions": 0, "spend": 332.14, "ecpc": 0.32, "ctr": 0.35, "conversionRate": 3.57, "viewConversionRate": 0, "cpa": 8.98, "totalCpa": 8.98, "totalValue": 148, "totalSumValue": 148, "sumValue": 148, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5, "conversionMetrics": [ { "name": "Install", "totalConversions": 37, "conversions": 37, "viewConversions": 0, "conversionRate": 3.57, "viewConversionRate": 0, "totalCpa": 8.98, "cpa": 8.98, "totalValue": 148, "totalSumValue": 148, "sumValue": 148, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5 }, { "name": "ArticleEngagement", "totalConversions": 100, "conversions": 99, "viewConversions": 1, "conversionRate": 9.56, "viewConversionRate": 0, "totalCpa": 3.32, "cpa": 3.35, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 }, { "name": "MobileSignup", "totalConversions": 24, "conversions": 24, "viewConversions": 0, "conversionRate": 2.32, "viewConversionRate": 0, "totalCpa": 13.84, "cpa": 13.84, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } ] } }, { "metadata": { "id": "009ccab152daff19c2f26990be7be1164b", "name": "CNN World", "publisherId": "0048938c4af9641f2e04565be89ece5954", "publisherName": "CNN (Turner U.S.)", "url": "http://www.cnn.com/world", "publisherUrl": "https://www.cnn.com", "isOen": false }, "metrics": { "impressions": 196995, "clicks": 472, "totalConversions": 14, "conversions": 14, "viewConversions": 0, "spend": 152.33, "ecpc": 0.32, "ctr": 0.24, "conversionRate": 2.97, "viewConversionRate": 0, "cpa": 10.88, "totalCpa": 10.88, "totalValue": 56, "totalSumValue": 56, "sumValue": 56, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5, "conversionMetrics": [ { "name": "Install", "totalConversions": 14, "conversions": 14, "viewConversions": 0, "conversionRate": 2.97, "viewConversionRate": 0, "totalCpa": 10.88, "cpa": 10.88, "totalValue": 56, "totalSumValue": 56, "sumValue": 56, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5 }, { "name": "ArticleEngagement", "totalConversions": 31, "conversions": 31, "viewConversions": 0, "conversionRate": 6.57, "viewConversionRate": 0, "totalCpa": 4.91, "cpa": 4.91, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 }, { "name": "MobileSignup", "totalConversions": 4, "conversions": 4, "viewConversions": 0, "conversionRate": 0.85, "viewConversionRate": 0, "totalCpa": 38.08, "cpa": 38.08, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } ] } } ], "totalResults": 3405 }, { "campaignId": "007100e5e10d8d937cb0a6a6efd7a5dd46", "results": [ { "metadata": { "id": "002eb98f6f1dee966af96f21d52d62df0b", "name": "CNN International - US", "publisherId": "007d5bdae84ea9f865307ba5e95aa29dda", "publisherName": "CNN Edition (Turner International)", "url": "http://edition.cnn.com/us/", "publisherUrl": "http://edition.cnn.com", "isOen": false }, "metrics": { "impressions": 150969, "clicks": 252, "totalConversions": 10, "conversions": 10, "viewConversions": 0, "spend": 144.6, "ecpc": 0.57, "ctr": 0.17, "conversionRate": 3.97, "viewConversionRate": 0, "cpa": 14.46, "totalCpa": 14.46, "totalValue": 40, "totalSumValue": 40, "sumValue": 40, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5, "conversionMetrics": [ { "name": "Install", "totalConversions": 10, "conversions": 10, "viewConversions": 0, "conversionRate": 3.97, "viewConversionRate": 0, "totalCpa": 14.46, "cpa": 14.46, "totalValue": 40, "totalSumValue": 40, "sumValue": 40, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5 }, { "name": "ArticleEngagement", "totalConversions": 16, "conversions": 15, "viewConversions": 1, "conversionRate": 5.95, "viewConversionRate": 0, "totalCpa": 9.04, "cpa": 9.64, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 }, { "name": "MobileSignup", "totalConversions": 9, "conversions": 9, "viewConversions": 0, "conversionRate": 3.57, "viewConversionRate": 0, "totalCpa": 16.07, "cpa": 16.07, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } ] } }, { "metadata": { "id": "004bf8173c11726f62d6d12dd832b5e570", "name": "Aviation", "publisherId": "007d5bdae84ea9f865307ba5e95aa29dda", "publisherName": "CNN Edition (Turner International)", "url": "http://edition.cnn.com/aviation", "publisherUrl": "http://edition.cnn.com", "isOen": false }, "metrics": { "impressions": 67621, "clicks": 238, "totalConversions": 14, "conversions": 14, "viewConversions": 0, "spend": 134.69, "ecpc": 0.57, "ctr": 0.35, "conversionRate": 5.88, "viewConversionRate": 0, "cpa": 9.62, "totalCpa": 9.62, "totalValue": 56, "totalSumValue": 56, "sumValue": 56, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5, "conversionMetrics": [ { "name": "Install", "totalConversions": 14, "conversions": 14, "viewConversions": 0, "conversionRate": 5.88, "viewConversionRate": 0, "totalCpa": 9.62, "cpa": 9.62, "totalValue": 56, "totalSumValue": 56, "sumValue": 56, "viewSumValue": 0, "totalAverageValue": 4, "averageValue": 4, "viewAverageValue": 0, "roas": 0.5, "totalRoas": 0.5 }, { "name": "ArticleEngagement", "totalConversions": 21, "conversions": 21, "viewConversions": 0, "conversionRate": 8.82, "viewConversionRate": 0, "totalCpa": 6.41, "cpa": 6.41, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 }, { "name": "MobileSignup", "totalConversions": 5, "conversions": 5, "viewConversions": 0, "conversionRate": 2.1, "viewConversionRate": 0, "totalCpa": 26.94, "cpa": 26.94, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } ] } } ], "totalResults": 3385 } ], "totalCampaigns": 3}