KEkevel

Create Scheduled Report

This creates a Scheduled Report. This endpoint uses the same body params as a queued report for the Criteria field.

post/v1/report/schedule

Request

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

Request body

Namestring required

A friendly name for the report

LoginIDinteger required

The LoginId for the user who should receive the report. This is the ID that's returned in the User Management API endpoints. You can pull a list here

KickoffDatestring required

The date to begin generating the report. We will use this date and the RecurrenceType to determine when the report should recur. Will accept a valid ISO 8601 date string.

SchedulingWindowinteger required

The timeframe in which the report should be delivered. All times are in GMT. Key 0 = Midnight to 6:00AM 1 = Between 6:00AM and Noon 2 = Between Noon and 6:00PM (18:00) 3 = Between 6:00PM (18:00) and Midnight

RecurrenceTypeinteger required

How often the report should be delivered. We will use the RecurrenceType to adjust the StartDate and EndDate from the criteria object with each recurring report. Key: 0 = no recurrence 1 = daily 2 = weekly 3 = monthly

Emailsstring[]

The external email addresses to email with the completed report. Each email address is a string, like "Emails":["1@2.com", "3@4.com"]

ShowEventsboolean

Display events (conversions, custom events, etc.). Default is false

ShowClickBucketingboolean

Display clicks sorted by click bucketing. Default is false

ShowRevenueboolean

Display revenue. Default is false

ShowConversionsboolean

Display conversions. Default is false

fixedDateboolean

Prevents the time frame of the report from incrementing with each send. Default is false

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": 12345,
  "KickoffDate": "2017-01-01T00:00:00",
  "SchedulingWindow": 1,
  "RecurrenceType": 1
}

Changes

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