Skip to content
Amplify APIReference

Retrieve performance statistics for all marketer campaigns by publisher

GET/reports/marketers/{id}/campaigns/publishers
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

limit?number

Number of results to return in this request for each campaign. default is 10.

campaignId?string

Limit to data of the campaign with the given ID / IDs.

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/publishers?from=2015-12-22&to=2016-01-20&limit=10&campaignId=e75f3cadc4fc128ab0419ababf4b02153e%2C+0069fc0fe9598f99b4c528f0881cd74b4b&offset=3&includeArchivedCampaigns=true&includeConversionDetails=false&conversionsByClickDate=true&enabledCampaignsOnly=true"
{  "campaignResults": [    {      "campaignId": "00d467100e5e10d8d937cb0a6a6efd7a5d",      "results": [        {          "metadata": {            "id": "007d5bdae84ea9f865307ba5e95aa29dda",            "name": "CNN Edition (Turner International)",            "url": "http://edition.cnn.com"          },          "metrics": {            "impressions": 722393,            "clicks": 1266,            "totalConversions": 64,            "conversions": 64,            "viewConversions": 0,            "spend": 712.9,            "ecpc": 0.56,            "ctr": 0.18,            "conversionRate": 5.06,            "viewConversionRate": 0,            "cpa": 11.14,            "totalCpa": 11.14,            "totalValue": 252,            "totalSumValue": 252,            "sumValue": 252,            "viewSumValue": 0,            "totalAverageValue": 3.94,            "averageValue": 3.94,            "viewAverageValue": 0,            "roas": 2.1,            "totalRoas": 2.1,            "conversionMetrics": [              {                "name": "Signup",                "totalConversions": 1,                "conversions": 1,                "viewConversions": 0,                "conversionRate": 0.08,                "viewConversionRate": 0,                "totalCpa": 712.9,                "cpa": 712.9,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              },              {                "name": "Install",                "totalConversions": 63,                "conversions": 63,                "viewConversions": 0,                "conversionRate": 4.98,                "viewConversionRate": 0,                "totalCpa": 11.32,                "cpa": 11.32,                "totalValue": 252,                "totalSumValue": 252,                "sumValue": 252,                "viewSumValue": 0,                "totalAverageValue": 4,                "averageValue": 4,                "viewAverageValue": 0,                "roas": 0.5,                "totalRoas": 0.7              },              {                "name": "Engagement",                "totalConversions": 98,                "conversions": 97,                "viewConversions": 1,                "conversionRate": 7.66,                "viewConversionRate": 0,                "totalCpa": 7.27,                "cpa": 7.35,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              },              {                "name": "Mobile",                "totalConversions": 43,                "conversions": 43,                "viewConversions": 0,                "conversionRate": 3.4,                "viewConversionRate": 0,                "totalCpa": 16.58,                "cpa": 16.58,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              }            ]          }        },        {          "metadata": {            "id": "0048938c4af9641f2e04565be89ece5954",            "name": "CNN (Turner U.S.)",            "url": "https://www.cnn.com"          },          "metrics": {            "impressions": 385376,            "clicks": 490,            "totalConversions": 18,            "conversions": 18,            "viewConversions": 0,            "spend": 262.47,            "ecpc": 0.54,            "ctr": 0.13,            "conversionRate": 3.67,            "viewConversionRate": 0,            "cpa": 14.58,            "totalCpa": 14.58,            "totalValue": 72,            "totalSumValue": 72,            "sumValue": 72,            "viewSumValue": 0,            "totalAverageValue": 4,            "averageValue": 4,            "viewAverageValue": 0,            "roas": 0.5,            "totalRoas": 0.8,            "conversionMetrics": [              {                "name": "Install",                "totalConversions": 18,                "conversions": 18,                "viewConversions": 0,                "conversionRate": 3.67,                "viewConversionRate": 0,                "totalCpa": 14.58,                "cpa": 14.58,                "totalValue": 72,                "totalSumValue": 72,                "sumValue": 72,                "viewSumValue": 0,                "totalAverageValue": 4,                "averageValue": 4,                "viewAverageValue": 0,                "roas": 0.5,                "totalRoas": 0.7              },              {                "name": "Engagement",                "totalConversions": 29,                "conversions": 28,                "viewConversions": 1,                "conversionRate": 5.71,                "viewConversionRate": 0,                "totalCpa": 9.05,                "cpa": 9.37,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              },              {                "name": "Mobile",                "totalConversions": 6,                "conversions": 6,                "viewConversions": 0,                "conversionRate": 1.22,                "viewConversionRate": 0,                "totalCpa": 43.75,                "cpa": 43.75,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              }            ]          }        }      ],      "totalResults": 815    },    {      "campaignId": "004c5152822eb27af11d7e0676cb2c84f6",      "results": [        {          "metadata": {            "id": "007d5bdae84ea9f865307ba5e95aa29dda",            "name": "CNN Edition (Turner International)",            "url": "http://edition.cnn.com"          },          "metrics": {            "impressions": 446299,            "clicks": 516,            "totalConversions": 23,            "conversions": 23,            "viewConversions": 0,            "spend": 112.5,            "ecpc": 0.22,            "ctr": 0.12,            "conversionRate": 4.46,            "viewConversionRate": 0,            "cpa": 4.89,            "totalCpa": 4.89,            "totalValue": 92,            "totalSumValue": 92,            "sumValue": 92,            "viewSumValue": 0,            "totalAverageValue": 4,            "averageValue": 4,            "viewAverageValue": 0,            "roas": 0.8,            "totalRoas": 1.1,            "conversionMetrics": [              {                "name": "Install",                "totalConversions": 23,                "conversions": 23,                "viewConversions": 0,                "conversionRate": 4.46,                "viewConversionRate": 0,                "totalCpa": 4.89,                "cpa": 4.89,                "totalValue": 92,                "totalSumValue": 92,                "sumValue": 92,                "viewSumValue": 0,                "totalAverageValue": 4,                "averageValue": 4,                "viewAverageValue": 0,                "roas": 0.5,                "totalRoas": 0.7              },              {                "name": "Engagement",                "totalConversions": 29,                "conversions": 28,                "viewConversions": 1,                "conversionRate": 5.43,                "viewConversionRate": 0,                "totalCpa": 3.88,                "cpa": 4.02,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              },              {                "name": "Mobile",                "totalConversions": 7,                "conversions": 7,                "viewConversions": 0,                "conversionRate": 1.36,                "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": "00e41072cc5f59e36c8be9b36b8208ac4c",            "name": "Microsoft One Promo Canada_EN (Microsoft One Promo)",            "url": "https://www.microsoft.com"          },          "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.5,            "totalRoas": 0.6,            "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.6              },              {                "name": "Engagement",                "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              }            ]          }        }      ],      "totalResults": 909    },    {      "campaignId": "00d2f861c8cf1e9b1e1394b15f24aec493",      "results": [        {          "metadata": {            "id": "0048938c4af9641f2e04565be89ece5954",            "name": "CNN (Turner U.S.)",            "url": "https://www.cnn.com"          },          "metrics": {            "impressions": 485570,            "clicks": 1309,            "totalConversions": 40,            "conversions": 40,            "viewConversions": 0,            "spend": 343.26,            "ecpc": 0.26,            "ctr": 0.27,            "conversionRate": 3.06,            "viewConversionRate": 0,            "cpa": 8.58,            "totalCpa": 8.58,            "totalValue": 160,            "totalSumValue": 160,            "sumValue": 160,            "viewSumValue": 0,            "totalAverageValue": 4,            "averageValue": 4,            "viewAverageValue": 0,            "roas": 0.5,            "totalRoas": 0.8,            "conversionMetrics": [              {                "name": "Install",                "totalConversions": 40,                "conversions": 40,                "viewConversions": 0,                "conversionRate": 3.06,                "viewConversionRate": 0,                "totalCpa": 8.58,                "cpa": 8.58,                "totalValue": 160,                "totalSumValue": 160,                "sumValue": 160,                "viewSumValue": 0,                "totalAverageValue": 4,                "averageValue": 4,                "viewAverageValue": 0,                "roas": 0.5,                "totalRoas": 0.7              },              {                "name": "Engagement",                "totalConversions": 97,                "conversions": 97,                "viewConversions": 0,                "conversionRate": 7.41,                "viewConversionRate": 0,                "totalCpa": 3.54,                "cpa": 3.54,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              },              {                "name": "Mobile",                "totalConversions": 18,                "conversions": 18,                "viewConversions": 0,                "conversionRate": 1.38,                "viewConversionRate": 0,                "totalCpa": 19.07,                "cpa": 19.07,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              }            ]          }        },        {          "metadata": {            "id": "006f78b958c0719b007fc916075c4d3449",            "name": "Time Magazine (Meredith)",            "url": "https://time.com"          },          "metrics": {            "impressions": 298634,            "clicks": 1044,            "totalConversions": 37,            "conversions": 37,            "viewConversions": 0,            "spend": 333.84,            "ecpc": 0.32,            "ctr": 0.35,            "conversionRate": 3.54,            "viewConversionRate": 0,            "cpa": 9.02,            "totalCpa": 9.02,            "totalValue": 148,            "totalSumValue": 148,            "sumValue": 148,            "viewSumValue": 0,            "totalAverageValue": 4,            "averageValue": 4,            "viewAverageValue": 0,            "roas": 0.8,            "totalRoas": 0.8,            "conversionMetrics": [              {                "name": "Install",                "totalConversions": 37,                "conversions": 37,                "viewConversions": 0,                "conversionRate": 3.54,                "viewConversionRate": 0,                "totalCpa": 9.02,                "cpa": 9.02,                "totalValue": 148,                "totalSumValue": 148,                "sumValue": 148,                "viewSumValue": 0,                "totalAverageValue": 4,                "averageValue": 4,                "viewAverageValue": 0,                "roas": 0.8,                "totalRoas": 0.8              },              {                "name": "Engagement",                "totalConversions": 100,                "conversions": 99,                "viewConversions": 1,                "conversionRate": 9.48,                "viewConversionRate": 0,                "totalCpa": 3.34,                "cpa": 3.37,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              },              {                "name": "Mobile",                "totalConversions": 24,                "conversions": 24,                "viewConversions": 0,                "conversionRate": 2.3,                "viewConversionRate": 0,                "totalCpa": 13.91,                "cpa": 13.91,                "totalValue": 0,                "totalSumValue": 0,                "sumValue": 0,                "viewSumValue": 0,                "totalAverageValue": 0,                "averageValue": 0,                "viewAverageValue": 0,                "roas": 0,                "totalRoas": 0              }            ]          }        }      ],      "totalResults": 824    }  ],  "totalCampaigns": 3}