KEkevel

Get Scheduled Report

This returns the properties of a scheduled report given a ScheduledReportId (the id from the Create Scheduled Reports Response).

get/v1/report/schedule/{ScheduledReportID}

Request

  • Base URL
    https://api.kevel.co
  • URL
    https://api.kevel.co/v1/report/schedule/{ScheduledReportID}
  • Auth
    API key in header X-Adzerk-ApiKey

Path parameters

ScheduledReportIDinteger required

The ID from the Create Scheduled Reports response

Response

200

Idinteger
Namestring
LoginIdinteger
KickoffDatestring
SchedulingWindowinteger
RecurrenceTypeinteger
IsDeletedboolean

Example response

{
  "Id": 1234,
  "Name": "Daily Report for Nike",
  "Criteria": {
    "StartDate": "2017-01-01T00:00:00",
    "EndDate": "2017-01-31T00:00:00",
    "Parameters": [
      {
        "siteId": 123456
      }
    ],
    "GroupBy": [
      "day"
    ],
    "ReportDateFormat": "iso8601"
  },
  "LoginId": 1234,
  "KickoffDate": "2017-01-31T00:00:00",
  "SchedulingWindow": 1,
  "RecurrenceType": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.