BEbencherdev
projects
alerts

List alerts for a project

Changed on

List all alerts for a project. If the project is public, then the user does not need to be authenticated. If the project is private, then the user must be authenticated and have view permissions for the project, or provide a valid project key for the project. By default, the alerts are sorted by status (active then dismissed) and modification date time in reverse chronological order. The HTTP response header X-Total-Count contains the total number of alerts.

get/v0/projects/{project}/alerts

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

projectstring required

The slug or UUID for a project.

Query parameters

direction'asc' | 'desc'

The direction to sort by. If not specified, the default sort direction is used.

pageinteger nullable

The page number to return. If not specified, the first page is returned.

per_pageinteger nullable

The number of items to return per page. If not specified, the default number of items per page (8) is used.

'created'

Sort by alert creation date time.

OR
'modified'

Sort by alert modified date time.

The field to sort by. If not specified, the default sort field is used.

archivedboolean nullable

If set to true, only returns archived alerts. If not set or set to false, only returns alerts with non-archived branches, testbeds, or measures.

'active'

The alert is active.

OR
'dismissed'

The alert has been dismissed by a user.

OR
'silenced'

The alert has been silenced by the system.

Filter alerts by their status. If not set, returns all alerts.

Response

successful operation

createdstring date-time required
iterationinteger required
limit'lower' | 'upper' required
modifiedstring date-time required
reportstring uuid required
uuidstring uuid required
valuenumber double required

The value the alert fired on.

The name that value was reported under is the threshold's, at threshold.metric, because that is the name the threshold checks.

Changes

  • 6b8d0bafd2ddRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      added the required property / to the response with the status

  • 4e91e95f3d45Revision changes
    • info

      added the required property / to the response with the status