Get Statistic Campaign, Adgroup, Ad
API get data statistic: Campaign, Adgroup, ad
URL
Request Params fix value
When call API, please send params with fix value (always send in API)
Param
Required
Value
_state
yes
app.report
_token
yes
_user_id
yes
1210044026
data_source_type
yes
2
format
yes
grid
Request parameters
Param
Required
Description
from_date
No
Start date get data statistic (example: 26/02/2020). Default is last 7 days
to_date
No
End date get data statistic (example: 03/03/2020). Default is yesterday.
limit
No
Default 10 row
page
No
Default: 1
metrics
yes
Hard value: PROCEEDS,CLICK,IMPRESSION
segments
yes
if get data Campaign, send value:
DAY,LINEITEM_IDif get data Ad Group, send value:
DAY,LINEITEM_ID,CAMPAIGN_IDif get data Ad, send value:
DAY,LINEITEM_ID,CAMPAIGN_ID,CREATIVE_ID
Example API
https://tiki.ants.vn/v3/admin/api/report/performance?_state=app.report&_token=&_user_id=1210044026&data_source_type=2&format=grid&from_date=26%2F02%2F2020&to_date=03%2F03%2F2020&limit=10&page=1&metrics=PROCEEDS,CLICK,IMPRESSION,ECPC_VAT&segments=DAY,LINEITEM_ID,CAMPAIGN_ID,CREATIVE_IDResponse parameters
Name
Description
day
Date
lineitem_id
The ID of the Campaign.
campaign_id
The ID of the Ad Group
creative_id
The ID of the Ad
proceeds
The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period. (campaign spend (cost))
click
The number of clicks.
impression
Count of how often your ad has appeared on a search results page
ecpc_vat
The total cost of all clicks divided by the total number of clicks received. (avg. cpc)
Status 200
{
  "code": 200,
  "message": "Success",
  "data": {
    "rows": [
      {
        "day": "Mar 03, 2020",
        "lineitem_id": "4758553215",
        "campaign_id": "4758932899",
        "creative_id": "4758933385",
        "proceeds": 1081582,
        "click": "20",
        "impression": "27",
        "ecpc_vat": "54079"
      }
    ],
    "total_records": "265814"
  }
}Last updated
Was this helpful?