Get stats of ads

GET /advertising/v1.0/ads/stats

Token

Endpoint for retrieving a stats of advertisements that belong to the current user.

Query parameters

advertisingCompanyId string
advertiserId string
adId string
page number(float)

Minimum value is 1. Default value is 1.
advertisingCompanyTag string
advertiserTag string
dateFrom string

Lower date limit in YYYY-MM-DD format

Format should match the following pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$.
dateTo string

Lower date limit in YYYY-MM-DD format

Format should match the following pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$.
fakeData boolean

Make testing possible in a non-production environment. Returns fake data in the response. Also pairs the fake data with already imported advertisements if possible.

Responses

200 application/json

Stats successfully retrieved
Hide response attributes Show response attributes object
- success boolean Required
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  adId string Required
  
  adThirdPartyId string
  
  advertiserId string
  
  advertiserThirdPartyId string
  
  advertisingCompanyId string
  
  advertisingCompanyThirdPartyId string
  
  stats object Required
  
  Object with various statistics.
  
  Additional properties are NOT allowed.
  
  Hide stats attributes Show stats attributes object
  
  listViews number(float)
  
  detailViews number(float)
- paginationInfo object Required
  
  Additional properties are NOT allowed.
  
  Hide paginationInfo attributes Show paginationInfo attributes object
  
  page number(float) Required
  
  pages number(float) Required

GET /advertising/v1.0/ads/stats

curl \
 --request GET 'http://apis.public-staging.reas.cz/advertising/v1.0/ads/stats' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "adId": "63d9007e66fc41b2cd1057c6",
      "adThirdPartyId": "string",
      "advertiserId": "63d9007e66fc41b2cd1057c6",
      "advertiserThirdPartyId": "string",
      "advertisingCompanyId": "63d9007e66fc41b2cd1057c6",
      "advertisingCompanyThirdPartyId": "string",
      "stats": {
        "listViews": 10,
        "detailViews": 5
      }
    }
  ],
  "paginationInfo": {
    "page": 42.0,
    "pages": 42.0
  }
}