Update Report

Updates a custom report.

put

Path Parameters

reportIdstring(uuid)required

The report’s ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

The request schema for the update report request.

Report

namestring

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

descriptionstring

An optional extended description for the report.

chart_typestring

Visualization type selected for this report.

Allowed values:HORIZONTAL_BARVERTICAL_BARLINE

Default:HORIZONTAL_BAR

time_rangeOne Of

The 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"}

RelativeTimeRangeobject
Show Child Parameters
queryobject
Show Child Parameters

Response

application/json

A response including a single report.

Report

idstring(uuid)read-only

The ID of the report.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representing when the report was created.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representing when the report was last updated.

Example:2022-11-04T20:10:06.927Z

created_bystring(uuid)read-only

The UUID of the Konnect user that created the report.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

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

descriptionstring

An optional extended description for the report.

chart_typestring

Visualization type selected for this report.

Allowed values:HORIZONTAL_BARVERTICAL_BARLINE

Default:HORIZONTAL_BAR

time_rangeOne Of

The 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"}

RelativeTimeRangeobject
Show Child Parameters
queryobject
Show Child Parameters
put/reports/{reportId}

Body

{ "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" ] } } }
 
application/json

Delete Custom Report

Deletes a custom report. Returns 404 if the report is not found.

delete

Path Parameters

reportIdstring(uuid)required

The report’s ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

No Content

delete/reports/{reportId}
 

Export as CSV

Exports report data in CSV format.

post

Query Parameters

tzstring

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

utc_formatboolean

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

reportIdstring(uuid)required

The ID of the report to export

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

text/csv

Report exported successfully

string
post/reports/{reportId}/export
 
text/csv

PaginatedMeta

object

Returns pagination information

pageobject

Contains pagination query parameters and the total number of entities returned.

Show Child Parameters
Example

Report

object
idstring(uuid)read-only

The ID of the report.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representing when the report was created.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representing when the report was last updated.

Example:2022-11-04T20:10:06.927Z

created_bystring(uuid)read-only

The UUID of the Konnect user that created the report.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

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

descriptionstring

An optional extended description for the report.

chart_typestring

Visualization type selected for this report.

Allowed values:HORIZONTAL_BARVERTICAL_BARLINE

Default:HORIZONTAL_BAR

time_rangeOne Of

The 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"}

RelativeTimeRangeobject
Show Child Parameters
queryobject
Show Child Parameters
Example