List Reports

πŸ“˜

GET https://api.kayzen.io/v1/reports

Use this API to get a list of all the existing reports or search for a specific report.

See below for supported fields and param

Field

Param

Required/ Optional

Description

advertiser_id

int

required

Unique ID per advertiser account

q

string

optional

Search query parameter. Returns results for a specific report. If no value is specified, then all reports data will be returned

page

int

optional

Returns page number. If nothing is selected, by default it will fetch 1 page

per_page

int

optional

Set number of rows per page. Default Value- 20 entries

sort_field

string

optional

Field to use for sort by function

sort_direction

asc/desc

optional

Show results in ascending or descending order.Default value -'desc' order

curl -X GET \
'https://api.kayzen.io/v1/reports?q=Report_test_&page=1&per_page=25&report_type%5B%5D=rtb&sort_direction=desc&sort_field=id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN'
{  
   "data":[  
      {  
         "id":2635,
         "advertiser_id":10298,
         "report_type_id":"rtb",
         "name":"Report_test",
         "start_date":"2019-01-01",
         "end_date":"2019-01-31",
         "date_macro":"last_month",
         "time_zone_id":11,
         "created_at":"2019-01-03T10:46:44.000Z",
         "time_zone_name":"(GMT+00:00) UTC"
      }
   ],
   "meta":{  
      "current_page":1,
      "total_pages":1,
      "total_entries":1
   }
}

What’s Next

Learn more about fetching report