List Custom Reports

Returns a list of custom reports.

get

Query Parameters

page[size]integer

How many items to include in a page.

Example:10

page[number]integer

The specific page number in the collection results.

Example:2

Response

application/json

A paginated list response for a collection of reports.

metaobject

Returns pagination information

Example:{"page":{"number":2,"size":10,"total":100}}

Show Child Parameters
dataarray[object]

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
get/reports
 
application/json

New Custom Report

Creates a new custom report.

post

Body

application/json

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

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
post/reports

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

Get a Custom Report

Returns a single report.

get

Path Parameters

reportIdstring(uuid)required

The report’s ID

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

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
get/reports/{reportId}
 
application/json

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}