Monitoring

List Issues

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Query parameters

idstringOptional
This will return issues with the specified id.
monitorIdstringOptional
This will return issues with the specified monitor ID.
policyIdstringOptional
This will return issues with the specified policy ID.
statusenumOptional
This will return issues with the specified status.
Allowed values:
pagedoubleOptional>=1
This is the page number to return. Defaults to 1.
sortOrderenumOptional
This is the sort order for pagination. Defaults to 'DESC'.
Allowed values:
limitdoubleOptional0-1000
This is the maximum number of items to return. Defaults to 100.
createdAtGtdatetimeOptional
This will return items where the createdAt is greater than the specified value.
createdAtLtdatetimeOptional
This will return items where the createdAt is less than the specified value.
createdAtGedatetimeOptional
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLedatetimeOptional
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGtdatetimeOptional
This will return items where the updatedAt is greater than the specified value.
updatedAtLtdatetimeOptional
This will return items where the updatedAt is less than the specified value.
updatedAtGedatetimeOptional
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLedatetimeOptional
This will return items where the updatedAt is less than or equal to the specified value.

Response

monitorIdstring
This is the ID of the monitor that triggered this issue.
policyIdstring
This is the ID of the policy that triggered this issue.
totalCallsdouble

This is the total number of calls made since created_at to determine percentage of calls affected.

statusenum
This is the status of the issue.
Allowed values:
idstring
This is the unique identifier for the issue.
orgIdstring
This is the unique identifier for the org that this issue belongs to.
createdAtdatetime

This is the ISO 8601 date-time string of when the issue was first detected.

updatedAtdatetime

This is the ISO 8601 date-time string of when the issue was last updated.

callslist of objects or null
These are the calls associated with this issue. This is only present when retrieving a single issue by ID.
acknowledgedBystring or null<=255 characters

This is the email/name of the user who acknowledged the issue.

resolvedBystring or null<=255 characters

This is the email/name of the user who resolved the issue.

acknowledgedAtdatetime or null

This is the ISO 8601 date-time string of when the issue was acknowledged.

resolvedAtdatetime or null

This is the ISO 8601 date-time string of when the issue was resolved.