Create Report

This endpoint retrieves a report owned by a client.

post/reports

Request body

namestring required

The name used to easily identify the report. Allowed values are between 2 and 255 characters.

typestring required

The type of report to be run. Allowed values: hit_miss_summary, browser_summary, os_summary, request_details_export, miss_details_export, health_check_export.

domain_idinteger required

The Domain ID the report will be associated with.

Response

201

idinteger

namestring

typestring

domain_idinteger

statusstring

Example response

{
  "id": 1,
  "name": "Testing Report",
  "type": "health_check_export",
  "parameters": {
    "date_end": "2020-02-13",
    "date_start": "2020-02-13"
  },
  "schedule": {
    "run_at": "2020-02-13 05:46:12"
  },
  "domain_id": 1000,
  "status": "scheduled"
}

Changes

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