Campaigns

GET {{baseUrl}}/legacy/offsite-ads/stats/campaigns?intervalSize=Day&clickAttributionPolicy=AnySeller&startDate=1962-03-29T08:35:04.625Z&endDate=1962-03-29T08:35:04.625Z&campaignId=Excepteur qui minim in&count=-50958279&advertiserId=-50958279

Dimensions

Get performance statistics aggregated for campaigns. The campaign id appears in the output as the first column.

Aggregation can be done by hour, day, month, or year. The aggregation interval size is controlled by intervalSize. The time interval appears in the output as the second column.

Metrics

The metrics reported by this endpoint are

The last six metrics can be computed in two ways depending on the policy to count only the sales that result from clicks on the same sellers product in a banner (same-seller) or not (any-seller). Reporting can be controlled by clickAttributionPolicy.

The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.

Filtering

The results can be filtered by campaign, date or count.

Filtering the results to events associated with a specific campaign is done by setting the campaignId filter parameter to the desired value.

Filtering the results to events that happened in a time interval is done by setting the startDate and endDate filter parameters using the yyyy-MM-DD format. The start date includes all events timestamped since the beginning of that day while the end date includes events until the end of day. The maximum duration of the date range is 1 year. If the aggregation interval is hour, then the maximum duration of the date range is 31 days. Note that month and year aggregate values may contain partial data for the interval if filtering by date.

Filtering the results to a maximum number of data rows is done by setting the count filter parameter. When combined with startDate this can be used to perform simple pagination.

Response Format

The representation format can be specified by MIME values in the Accept header. For now the only supported values for the accept header is application/json and text/csv.

{
   "columns": [ "campaignId", "month", "impressions", "clicks", "cost", "saleUnits", "revenue", "cr", "cpo", "cos", "roas" ],
   "data": [
       [168423, "2019-05-01", 3969032, 13410, 1111.295, 985, 190758099, 0.073, 1.128, 0.000, 171653.880 ],
       [168423, "2019-06-01", 8479603, 25619, 2190.705, 740, 152783656, 0.028, 2.960, 0.000, 69741.775 ]
       ],
   "rows": 2
}

The JSON result is an object with three fields (columns, data, and rows). The �columns� array acts as the header for the data rows. The categorical dimension column comes first and consists of the campaign id. The interval column comes next and defines the aggregation period. The interval size is determined by the intervalSize parameter. This is followed by either nine or fifteen metrics columns. The first three metrics (impressions, clicks, and cost) always appear. The remaining depend on the clickAttributionPolicy parameter.

The �data� array contains data rows whose values match the entries in the �columns� array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects whose type is number. Some of these are natural numbers (e.g. clicks and impressions) whereas others are decimal values. A divide by zero yields null. The currency is assumed to be the local currency established by the advertiser.

The �row� value is a count of the number of rows in the data array, and can be used to check the integrity of the data.

Further information on the campaign or seller (e.g. the seller name) can be obtained from the existing V1 or V2 endpoints using the campaign and/or seller ID values.

Request Params

RESPONSES

status: OK

"\u003cbyte\u003e"