Custom Reports
List Custom Reports
Returns a list of custom reports.
Query Parameters
How many items to include in a page.
Example:10
The specific page number in the collection results.
Example:2
Response
application/json
Response
A paginated list response for a collection of reports.
Returns pagination information
Example:{"page":{"number":2,"size":10,"total":100}}
Show Child Parameters
Example:{"summary":"Bar chart of status codes by API product for the past 24 hours","description":"A vertical bar chart grouping data first by API product, then by status code, for the past 24 hours.","value":{"name":"Status codes by service","chart_type":"VERTICAL_BAR","time_range":{"type":"RELATIVE","time_period":"24H"},"query":{"metrics":["REQUEST_COUNT"],"dimensions":["API_PRODUCT","STATUS_CODE"]}}}
Show Child Parameters
Query Parameters
New Custom Report
Creates a new custom report.
Body
application/json
Body
The request schema for the create report request.
If you pass the same name and description of an existing report in the request, a report with the same name and description will be created. The two reports will have different id values to differentiate them.
Note that all fields are optional: if you pass an empty JSON object as the request ({}), a new report will be created with a default configuration.
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
Body
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"}