Create Queued Report

post

https://api.kevel.co/v1/report/queue

This endpoint makes a request in the Kevel database for the criteria passed in the parameters, and then returns a GUID that can be used to pull the finished report. Criteria can be specified for the report using an object titled "criteria". Report IDs will persist for 10 days.

Body Params

StartDateISO

string

required

The start date of the report in ISO 8601 format. Format: YYYY-MM-DDTHH:MM:SS, such as: '2016-06-01T00:00:00'

EndDateISO

string

required

The end date of the report in ISO 8601 format. Format: YYYY-MM-DDTHH:MM:SS, such as: '2016-06-01T00:00:00'

GroupBy

array of strings

required

Object containing list of strings. One is required: day, week, month, or empty array (for total). You can also optionally break down by additional parameters listed here. Such as "GroupBy": ["day","campaignId"].

GroupBy*

Parameters

object

required

List of key/value pairs used for filtering. It's an unlimited number of criteria that will filter the report. More info here. Such as "Parameters": [{"brandId": 12}]

ExcludeParameters

object

List of key/value pairs used for filtering. It's an unlimited number of criteria that will filter the report. More info here. Such as "ExcludeParameters": [{"brandId": 12}]

TimeZone

string

Generates the report for a specific timezone from the list of valid timezone strings. Default is GMT (UTC). Ex. "TimeZone": "America/New_York"

CustomizedCsvColumnNames

array of objects

Provide a list of original-to-new mappings to rename CSV column names.

CustomizedCsvColumnNames

CsvReportVisibility

string

Defaults to none

Specify whether the report will be publicly available via CSV download link. Allowed options: ("none", "public"), defaults to "none" for Queued Reports, "public" for Scheduled Reports. This is useful if you intend to run a Queued Report and then embed the (report_run_csv_url in /v2/reportruns) into an email / Self-Serve without authentication. (e.g. curl -XGET https://api.kevel.co/v2/report/download/a87ece06-28cd-4267-9314-e830af7eaa12/public?filename=foobar)

CsvColumns

array of strings

List of CSV columns to export in the generated CSV. If undefined or empty, all columns are exported.

CsvColumns

ExcludeCsvColumns

array of strings

List of CSV columns to exclude from the exported CSV.

ExcludeCsvColumns

ReportDateFormat

string

enum

Date format to display in the "Date" column of the Report CSV, possible values: "us", "iso8601"

Allowed:

Response

200200