---
title: "Create Queued Report"
method: POST
path: "/v1/report/queue"
---

# Create Queued Report

`POST /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.

## Request body

- object
  - `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` string[], 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](https://dev.kevel.com/reference/reporting-api-1#groupby-and-parameter-fields---optional). Such as `"GroupBy": ["day","campaignId"]`.
  - `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](https://dev.kevel.com/reference/reporting-api-1#groupby-and-parameter-fields---optional). Such as `"Parameters": [{"brandId": 12}]`
    - string — The name of the parameter you want to filter by
  - `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](https://dev.kevel.com/reference/reporting-api-1#groupby-and-parameter-fields---optional). Such as `"ExcludeParameters": [{"brandId": 12}]`
    - string — The name of the parameter you want to filter by
  - `TimeZone` string — Generates the report for a specific timezone from the [list of valid timezone strings](https://dev.adzerk.com/docs/time-zones-1#available-time-zones-strings). Default is GMT (UTC). Ex. "TimeZone": "America/New_York"
  - `CustomizedCsvColumnNames` object[] — Provide a list of original-to-new mappings to rename CSV column names.
    - `original` string — The name of the original CSV column name that you want to rename.
    - `new` string — The name of the new CSV column name that you want `original` to be renamed to.
  - `CsvReportVisibility` string — 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` string[] — List of CSV columns to export in the generated CSV. If undefined or empty, all columns are exported.
  - `ExcludeCsvColumns` string[] — List of CSV columns to exclude from the exported CSV.
  - `ReportDateFormat` 'us' | 'iso8601' — Date format to display in the "Date" column of the Report CSV, possible values: "us", "iso8601"
  - `FlatRateAccrualMethod` 'startdateaccrual' | 'norevenueaccrual' — Strategy to use to when considering revenue from flat rate flights. If undefined, the network default is used. - startdateaccrual: Assign the revenue to the timeslice at the flight's start date - norevenueaccrual: Ignore the revenue from flat rate flights.

## Response `200`

200

- object
  - `Id` string

---

[API](https://skmtc.net/kevel/apis/engine-apis.md) · [All operations](https://skmtc.net/kevel/apis/engine-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kevel/engine-apis/revisions/0ca55f45aa7d/schema)