What You Can Group & Filter By

Property	Group By (`GroupBy`)	Filter By (`Parameters`)
`day`, `week`, `month`, `hour`	Yes	No
`brandId`, `campaignId`, `optionId`, `creativeId`, `adTypeId`, `siteId`, `zoneId`, `publisherAccountId`, `countryCode`, `metroCode`, `keyword`, `regionCode`, `city`	Yes	Yes

👍
regionCode and city are in Beta. Contact your account manager to get started.
When grouping/filtering by region, you must also group/filter by countryCode.

Important Troubleshooting Notes

Reports that are grouped by Keyword AND Country or Metro AND include a longer than 31 day time span are too large to be queued.
StartDate and EndDate are additional deprecated body params that use MM/DD/YYYY format. However, if you do not have your dates in ISO 8601 format, it's possible to use these params instead. StartDateISO overrides StartDate if different.
If you choose the GroupBy optionId, your report will also be grouped by RateTypeId. This is to break out data on separate lines if your flight changed RateType during the time period.
FlightId will be returned as OptionId in the report.
Reports that GroupBy hour cannot use a time frame longer than 35 days from the present.
You cannot queue a report that groups by or filters by both Keywords and Region or City.

Report Creation Errors

All errors are wrapped in an {"Error"} object.

Error Code	JSON Response	Error Description
500	`"Server Error"`	Report queuing is unavailable. Check the status page for details. If none are available, contact Kevel support
403	`"Invalid API key"`	No API key in request, or the key does not belong to an account
400	`"Missing required parameter: criteria"`	No `criteria` object in the request
400	`{"Validation errors": {"JSON parse error": <error-detail-string>}}`	Invalid JSON passed in the request. Includes a string with the parsing error
400	`{"Validation errors": {"End": "Start must precede end"}}`	The Start Date is after the End Date
400	`{"Validation errors": {"StartDate": "StartDate must not be specified when StartDateISO is."}}`	Both `StartDate` and `StartDateISO` are supplied
400	`{"Validation errors": {"EndDate": "EndDate must not be specified when EndDateISO is."}}`	Both `EndDate` and `EndDateISO` are supplied
400	`{"Validation errors":{"StartDate":{"reason":"Invalid date format: 'xxxxx' is malformed at 'xxxxx'. Dates should be formatted like MM/dd/yyyy, e.g. 12/31/2016"}`	`StartDate` or `EndDate` are not formatted correctly
400	`{"Validation errors":{"StartDateISO":{"reason":"Invalid date format: 'xxxxx' is malformed at 'xxxxx'. Dates should be formatted like yyyy-MM-dd'T'HH:mm:SS, e.g. 2016-12-31T00:00:00"}`	`StartDateISO` or `EndDateISO` are not formatted correctly
400	`{"Validation errors":{"GroupBy":{"reason":"GroupBy not an array"}}}`	A parameter (such as `GroupBy`) uses the wrong data type
400	`{"Validation errors":{"GroupBy":{"reason":"GroupBy contains some elements that are not strings.","elements":[1234,"campaignId"]}}}`	One of the `GroupBy` elements uses the wrong data type
400	`{"Validation errors":{"GroupBy":{"fields":["flightid"],"reason":"Invalid GroupBy fields. Valid values must be one of 'adtypeid', 'brandid', 'campaignid', 'countrycode', 'creativeid', 'day', 'keyword', 'metrocode', 'month', 'optionid', 'publisheraccountid', 'siteid', 'week', 'zoneid'."}}}`	Invalid `GroupBy` element
400	`{"Validation errors":{"Parameters":{"reason":"Parameters not an array.","value":1234}}}`	`Parameters` is not an object
400	`{"Validation errors":{"Parameters":[{"param":{},"reason":"parameter object must have one property"}]}}`	`Parameters` must have at least one property
400	`{"Validation errors":{"Parameters":[{"name":"foo","reason":"invalid parameter name"}]}}`	Parameter property does not exist
400	`{"Validation errors":{"Parameters":[{"parameter":"SiteId","bad-value":"foo","reason":"id parameter value must be a positive integer"}]}}`	Parameter value must be an integer
400	`{"Validation errors":{"Parameters":[{"parameter":"metroCode","bad-value":1000,"reason":"metroCode, countryCode, and keyword values must be strings"}]}}`	Parameter value must be a string (in the case of `metroCode`, `countryCode`, and `keyword`)
400	`{"Validation errors":{"ReportTooLarge":"A report grouping by Keyword and either Country or Metro cannot exceed a one month (31 day) span."}}}`	Reports that are grouped by Keyword and Country/Metro AND include a longer than 31 day time span cannot be queued.
400	`{"Validation errors":{"ReportTooLarge":"An hourly report can only be requested for dates within the last 35 days."}}`	Reports that use the hourly date group can only be requested for a period within the past 35 days.
400	`{"Error":{"Validation errors":{"TimeZone":"Time Zones are not supported on keyword reports."}}}`	Reports cannot use both keywords and non-GMT (UTC) timezones.