Performance Report API

WARNING

An authentication token is required when calling this API. See Token Usage Guide for details.

Note: Data is usually generated about 5 hours after the end of the day.
For example, if you're querying data for August 1st (UTC), it will be available around 5:00 AM on August 2nd (UTC).

Request URL

https://scaler.taurusx.com/openapi/performance_data

Request Method

GET

Request Parameters

FieldRequiredTypeDescriptionDefaultExample
timezoneNostringThe time zone for the data+0+0
report_typeNostringType of reporteventevent
start_timeYesstringStart date for the query, format "yyyy-MM-dd", supports querying past 7 days"2023-04-23"
end_timeYesstringEnd date for the query, format "yyyy-MM-dd", supports querying past 7 days"2023-04-24"
dimension_optionYesstringReporting dimensions (see explanation below)Campaign,Country

dimension_option Explanation

Multiple dimensions can be specified, separated by commas ,.

  • "Campaign": Breakdown by Campaign ID
  • "Adgroup": Breakdown by Ad Group ID
  • "Creative": Breakdown by Creative ID
  • "AdType": Breakdown by creative type
  • "Country": Breakdown by country (2-letter ISO code)

Response Field Descriptions

NameParentTypeDescription
codeint200 indicates success; other values indicate failure
datajsonResult object
data_listdataarray<json>Report data list
datedata_liststringDate, in format "yyyy-MM-dd"
campaign_iddata_liststringCampaign ID
campaign_namedata_liststringCampaign name
adgroup_iddata_liststringAd Group ID
adgroup_namedata_liststringAd Group name
creative_iddata_liststringCreative ID
creative_namedata_liststringCreative name
ad_typedata_liststringCreative type, e.g., image, nativeImg, video, videoEndCard, html, videoHtml
countrydata_liststringCountry code (2-letter ISO code)
impressionsdata_listnumberNumber of impressions
clicksdata_listnumberNumber of clicks
conversionsdata_listnumberNumber of conversions
costdata_listnumberCost in USD

Example Response

json
{
  "code": 200,
  "data": {
    "data_list": [
      {
        "date": "2023-10-20",
        "campaign_id": 100115,
        "campaign_name": "Test name",
        "adgroup_id": 1000228,
        "adgroup_name": "Test name",
        "creative_id": 10001116,
        "creative_name": "Test name",
        "ad_type": "image",
        "country": "BR",
        "clicks": 118.0,
        "conversions": 0.0,
        "cost": 0.293090625116,
        "impressions": 298.0
      },
      {
        "date": "2023-10-21",
        "campaign_id": 100115,
        "campaign_name": "Test name",
        "adgroup_id": 1000228,
        "adgroup_name": "Test name",
        "creative_id": 10001117,
        "creative_name": "Test name",
        "ad_type": "video",
        "country": "BR",
        "clicks": 104.0,
        "conversions": 0.0,
        "cost": 0.08020019578,
        "impressions": 214.0
      }
    ]
  }
}
{
  "code": 200,
  "data": {
    "data_list": [
      {
        "date": "2023-10-20",
        "campaign_id": 100115,
        "campaign_name": "Test name",
        "adgroup_id": 1000228,
        "adgroup_name": "Test name",
        "creative_id": 10001116,
        "creative_name": "Test name",
        "ad_type": "image",
        "country": "BR",
        "clicks": 118.0,
        "conversions": 0.0,
        "cost": 0.293090625116,
        "impressions": 298.0
      },
      {
        "date": "2023-10-21",
        "campaign_id": 100115,
        "campaign_name": "Test name",
        "adgroup_id": 1000228,
        "adgroup_name": "Test name",
        "creative_id": 10001117,
        "creative_name": "Test name",
        "ad_type": "video",
        "country": "BR",
        "clicks": 104.0,
        "conversions": 0.0,
        "cost": 0.08020019578,
        "impressions": 214.0
      }
    ]
  }
}