Amplify APIReference
Retrieve periodic performance statistics by promoted link for a campaign
GET
/reports/marketers/{id}/campaigns/{campaignId}/periodicContentAuthorization
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
campaignId*string
Limit to data of the campaign with the given IDs.
Query Parameters
from?string
Start day Date
to?string
End day Date
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.
filter?string
Can have the following values impressions, clicks, ctr, spend, ecpc, conversions, conversionRate, cpa, id, fromDate and toDate. For more details about reports filtering read this.
breakdown?string
Defines the periodic breakdown of data, either daily, weekly or monthly. Default is daily.
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/e75f3cadc4fc128ab0419ababf4b02153e, 0069fc0fe9598f99b4c528f0881cd74b4b/periodicContent?from=2015-12-22&to=2016-01-20&limit=10&offset=3&filter=clicks%2Bgt%2B99&breakdown=monthly&includeConversionDetails=false&conversionsByClickDate=true&enabledCampaignsOnly=true"{ "promotedLinkResults": [ { "promotedLinkId": "00eb6326d9aae6274257e1a7859f6b5def", "results": [ { "metadata": { "id": "2019-05-12", "fromDate": "2019-05-12", "toDate": "2019-05-12" }, "metrics": { "impressions": 6038, "clicks": 3, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 2.52, "ecpc": 0.84, "ctr": 0.05, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "2019-05-11", "fromDate": "2019-05-11", "toDate": "2019-05-11" }, "metrics": { "impressions": 4116, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 2 }, { "promotedLinkId": "00df91d18ad09d7e2c921de63e46e917d1", "results": [ { "metadata": { "id": "2019-05-12", "fromDate": "2019-05-12", "toDate": "2019-05-12" }, "metrics": { "impressions": 5015, "clicks": 1, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0.84, "ecpc": 0.84, "ctr": 0.02, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "2019-05-11", "fromDate": "2019-05-11", "toDate": "2019-05-11" }, "metrics": { "impressions": 4630, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 2 }, { "promotedLinkId": "00ce19691b1d5d249ed895e8a380c5747f", "results": [ { "metadata": { "id": "2019-05-12", "fromDate": "2019-05-12", "toDate": "2019-05-12" }, "metrics": { "impressions": 9235, "clicks": 4, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 3.99, "ecpc": 1, "ctr": 0.04, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "2019-05-11", "fromDate": "2019-05-11", "toDate": "2019-05-11" }, "metrics": { "impressions": 972, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 2 }, { "promotedLinkId": "0068ac63f28b26744224df62a82f7e8352", "results": [ { "metadata": { "id": "2019-05-12", "fromDate": "2019-05-12", "toDate": "2019-05-12" }, "metrics": { "impressions": 10947, "clicks": 8, "totalConversions": 1, "conversions": 1, "viewConversions": 0, "spend": 6.93, "ecpc": 0.87, "ctr": 0.07, "conversionRate": 12.5, "viewConversionRate": 0, "cpa": 6.93, "totalCpa": 6.93, "totalValue": 49.99, "totalSumValue": 49.99, "sumValue": 49.99, "viewSumValue": 0, "totalAverageValue": 49.99, "averageValue": 49.99, "viewAverageValue": 0, "roas": 7.2, "totalRoas": 7.2 } }, { "metadata": { "id": "2019-05-11", "fromDate": "2019-05-11", "toDate": "2019-05-11" }, "metrics": { "impressions": 890, "clicks": 1, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 1.05, "ecpc": 1.05, "ctr": 0.11, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 2 }, { "promotedLinkId": "00345683227f1cbb7e6f025f0eee22c05c", "results": [ { "metadata": { "id": "2019-05-12", "fromDate": "2019-05-12", "toDate": "2019-05-12" }, "metrics": { "impressions": 2422, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } }, { "metadata": { "id": "2019-05-11", "fromDate": "2019-05-11", "toDate": "2019-05-11" }, "metrics": { "impressions": 1677, "clicks": 0, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 0, "ecpc": 0, "ctr": 0, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 2 }, { "promotedLinkId": "00d2aef767c1f34c087be00855b9ea3dd0", "results": [ { "metadata": { "id": "2019-05-12", "fromDate": "2019-05-12", "toDate": "2019-05-12" }, "metrics": { "impressions": 59415, "clicks": 85, "totalConversions": 1, "conversions": 1, "viewConversions": 0, "spend": 71.68, "ecpc": 0.84, "ctr": 0.14, "conversionRate": 1.18, "viewConversionRate": 0, "cpa": 71.68, "totalCpa": 71.68, "totalValue": 47.99, "totalSumValue": 47.99, "sumValue": 47.99, "viewSumValue": 0, "totalAverageValue": 47.99, "averageValue": 47.99, "viewAverageValue": 0, "roas": 0.6, "totalRoas": 0.6 } }, { "metadata": { "id": "2019-05-11", "fromDate": "2019-05-11", "toDate": "2019-05-11" }, "metrics": { "impressions": 19106, "clicks": 12, "totalConversions": 0, "conversions": 0, "viewConversions": 0, "spend": 8.19, "ecpc": 0.68, "ctr": 0.06, "conversionRate": 0, "viewConversionRate": 0, "cpa": 0, "totalCpa": 0, "totalValue": 0, "totalSumValue": 0, "sumValue": 0, "viewSumValue": 0, "totalAverageValue": 0, "averageValue": 0, "viewAverageValue": 0, "roas": 0, "totalRoas": 0 } } ], "totalResults": 2 } ], "totalPromotedLinks": 6}