Update Existing Report

πŸ“˜

PUT https://api.kayzen.io/v1/reports/:id

You can update an already existing report. All the parameters which are used while creating a report can be updated and modified

Parameters for Updating Existing Report

Field

Param

Required/ Optional

Description

advertiser_id

int

required

Unique ID per advertiser account

name

string

required

Name of the report

report_type_id

string

required

Only supported value is rtb

date_macro

string

optional

Select specific day or range of days. Supported Values -
today
yesterday
last_three_days
last_seven_days
this_month
last_month

start_date

YYYY-MM-DD

required

Start date of report eg: 2019-01-01

end_date

YYYY-MM-DD

required

End date of report eg: 2019-01-31

metrics

array of string

required

Array of supported metrics. Please refer to Supported Parameters

filters

JSON Object/Hash

optional

JSON object with key as reporting filter property and value as array of filter values. Please refer to Supported Parameters

group_by

array of string

required

List of dimensions to group by. Please refer to Supported Parameters

curl -X PUT \
'https://api.kayzen.io/v1/reports/:id' \
-d '{
  "id": 2641,
  "name": "Report 1",
  "report_type_id": "rtb",
  "time_zone_id": 11,
  "metrics": [
    "wins",
    "impressions",
    "clicks",
    "win_rate",
    "advertiser_spend"
  ],
  "filters": {
    "campaign_id": [
      108996,
      108997
    ]
  },
  "group_by": [
    "day",
    "line_item_id",
    "campaign_id"
  ],
  "attribution_sources":[
    "mmp",
    "assisted"
  ],
  "attribution_types":[
    "click",
    "total"
   ],
  "date_macro": "last_seven_days",
  "start_date": "2019-04-19",
  "end_date": "2019-04-25"
}' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN'
{  
   "id":2641,
   "advertiser_id":10298,
   "name":"Report 1",
   "start_date":"2019-04-19",
   "end_date":"2019-04-25",
   "date_macro":"last_seven_days",
   "time_zone_id":11,
   "metrics":[  
      "wins",
      "impressions",
      "clicks",
      "win_rate",
      "advertiser_spend"
   ],
   "filters":{  
      "campaign_id":[  
         108996,
         108997
      ]
   },
   "group_by":[  
      "day",
      "line_item_id",
      "campaign_id"
   ],
   "attribution_sources":[
     "mmp",
     "assisted"
   ],
   "attribution_types":[
     "click",
     "total"
   ],
   "created_at":"2019-04-24T21:45:33.000Z",
   "last_updated_at":null,
   "time_zone_name":"(GMT+00:00) UTC"
}