Grid

Returns report data restricted by query parameters passed in POST arguments.

post

Authorizations

bearerAuth

Body

application/json

start_datestring · dateRequired

example: 2017-07-21

end_datestring · dateRequired

example: 2017-07-21

limitnumberOptional

offsetnumberOptional

include_mappingsnumber · enumOptional

0 - by default if one split_by field

1 - by default if more than one split_by field

Possible values:

timezonenumberOptional

filter_templatestringOptional

A string template defining priorities for filters specified in the filters POST argument. Can contain the following elements: opening/closing parentheses OR/AND operators x character as placeholder for filters Example: x OR (x AND x).

data_filter_templatestringOptional

A string template defining priorities for filters specified in the data_filters POST argument. Can contain the following elements: opening/closing parentheses OR/AND operators x character as a placeholder for filters Example: x OR (x AND x).

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /grid HTTP/1.1
Host: api.reporting-studio.ads.sportradar.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "split_by": [
    "demand.advertiser_id"
  ],
  "start_date": "2021-05-20",
  "end_date": "2021-05-25"
}

Date Range QueryLimit and Offset QueryOrder by advertiser id DescOrder by advertiser mapping DescGroup by multiple dimensionsLoad data fieldsChange timezoneFilter by one dimension: contains valueFilter by one dimension: equals valueFilter by one dimension: not contains valueFilter by one dimension: not equals valueFilter by one dimension: starts with valueFilter by one dimension: ends with valueFilter by one dimension mapping: contains valueFilter by one dimension mapping: contains case insensitive valueFilter by one dimension mapping: multiple and equalsFilter by one dimension mapping: multiple or equalsFilter by one dimension mapping: combine different types(and)Filter dimension by custom filter templateFilter data field by rangeFilter data field by range with custom filter template

200

OK

{
  "status": "success",
  "total": {
    "data": {
      "name": "text",
      "value": 1,
      "comment": "text"
    },
    "records_found": 1,
    "confidence_range": "text",
    "dates": {}
  },
  "rows": [
    {
      "data": [
        {
          "name": "payout.actual_adv_usd",
          "percent": "text",
          "value": 1,
          "comment": "text"
        }
      ],
      "name": "text",
      "mapping": "text",
      "confidence_range": "text"
    }
  ]
}