Get a Custom Report
Returns a single report.
Path Parameters
The report’s ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
A response including a single report.
Report
The ID of the report.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representing when the report was created.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representing when the report was last updated.
Example:2022-11-04T20:10:06.927Z
The UUID of the Konnect user that created the report.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The user-provided name for the report.
If not provided, the report will be named “Untitled Report” with a timestamp suffix.
>= 1 characters<= 255 characters
An optional extended description for the report.
Visualization type selected for this report.
Allowed values:HORIZONTAL_BARVERTICAL_BARLINE
Default:HORIZONTAL_BAR
One OfThe period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of last 24 hours will be chosen.
Default:{"type":"RELATIVE","time_period":"24H"}
Show Child Parameters
Show Child Parameters
Path Parameters
Update Report
Updates a custom report.
Path Parameters
The report’s ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
The request schema for the update report request.
Report
The user-provided name for the report.
If not provided, the report will be named “Untitled Report” with a timestamp suffix.
>= 1 characters<= 255 characters
An optional extended description for the report.
Visualization type selected for this report.
Allowed values:HORIZONTAL_BARVERTICAL_BARLINE
Default:HORIZONTAL_BAR
One OfThe period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of last 24 hours will be chosen.
Default:{"type":"RELATIVE","time_period":"24H"}
Show Child Parameters
Show Child Parameters
Response
application/json
Response
A response including a single report.
Report
The ID of the report.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representing when the report was created.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representing when the report was last updated.
Example:2022-11-04T20:10:06.927Z
The UUID of the Konnect user that created the report.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The user-provided name for the report.
If not provided, the report will be named “Untitled Report” with a timestamp suffix.
>= 1 characters<= 255 characters
An optional extended description for the report.
Visualization type selected for this report.
Allowed values:HORIZONTAL_BARVERTICAL_BARLINE
Default:HORIZONTAL_BAR
One OfThe period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of last 24 hours will be chosen.
Default:{"type":"RELATIVE","time_period":"24H"}
Show Child Parameters
Show Child Parameters
Path Parameters
Body
Delete Custom Report
Deletes a custom report. Returns 404 if the report is not found.
Path Parameters
The report’s ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Path Parameters
Export as CSV
Exports report data in CSV format.
Query Parameters
The timezone to use for the report. This impacts several things:
- The timestamps returned, if time is a dimension.
- Day boundaries for reports, meaning that if the report implicitly has a granularity of DAILY or higher, the same query may return different data depending on the timezone selected.
Example:Etc/UTC
If true, export timestamps in “programmer friendly” format (ISO-8601, UTC timezone).
If false, export in “spreadsheet friendly” format (local time without timezone specifier).
Note: this does NOT impact the timezone of the report, merely the format of the time column if one is present.
Path Parameters
The ID of the report to export
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
text/csv
Response
Report exported successfully
Path Parameters
Query Parameters
PaginatedMeta
objectReturns pagination information
Contains pagination query parameters and the total number of entities returned.