PingPong API docs API Reference

This is the API documentation for PingPong Status Pages.

To utilize the API you need an account, create your account today.

The PingPong API is organized around the REST methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an api-key which can be obtained from your developer dashboard. Create an account today to obtain your API key.

API Endpoint
https://api.pingpong.one/rest/v1
Terms of Service: https://pingpong.one/terms/
Contact: support@pingpong.one
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0

Authentication

Token

Obtaining your API-key

Signin to your account and go to new api integration.

Using your API-key

Authenticate to the API by passing the authorization token header to all requests, like this example:

curl -H "Authorization: Token 5c10213ag542d5738bbeaabbe12f35ef9c89f537" \
  https://api.pingpong.one/rest/v1/status
type
apiKey
in
header

Status

Global status page status, for all components.

Get system status

GET /status

Returns current status for all components. This endpoint could be used for widgets or badges to showcase current status.

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
{
  "status": "All systems operational",
  "status_color": "green"
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Live

Ongoing incidents and maintenance.

Get live events

GET /live

Returns information about status page and lists of currently ongoing incidents or maintenance. Useful for notification bar widgets.

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
{
  "project": "ACME",
  "url": "https://acme.pingpong.host",
  "incidents": [],
  "maintenance": [
    {
      "id": "k9gVLLPoNgbPA72HQKvy2b",
      "project": "ACME",
      "name": "Database migration",
      "created_at": "2020-02-03T12:15:58Z",
      "status": "In progress",
      "affected_components": [
        {
          "id": "GZ7tIAmLacSDW7sHe9Fskl",
          "project": "ACME",
          "name": "API",
          "group": "System",
          "created_at": "2020-02-07T14:22:03Z",
          "status": "Maintenance mode",
          "status_color": "gray",
          "description": null,
          "showcased": true
        }
      ],
      "reported_by": "Donald Duck",
      "scheduled_for": "2020-02-10T22:00:00Z",
      "ends_at": "2020-02-10T23:00:00Z",
      "message": "Upgrading version of <b>main database</b> from version 9.0 to <strikethrough>10.0</strikethrough> 10.2."
    }
  ]
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Component

Components are the individual parts of your system that can be listed on your status page.

List components

GET /components

Returns a list of all components.

200 OK

OK

type
401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "GZ7tIAmLacSDW7sHe9Fskl",
    "project": "ACME",
    "name": "API",
    "group": "System",
    "created_at": "2020-02-07T14:22:03Z",
    "status": "Operational",
    "status_color": "green",
    "description": null,
    "showcased": true
  },
  {
    "id": "bHH6yReKWkL92llkdk6sd7",
    "name": "DB",
    "group": "System",
    "created_at": "2020-03-12T15:42:19Z",
    "status": "Major issues",
    "status_color": "orange",
    "description": "All databases, including read-only replicas",
    "showcased": false
  }
]
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Get component

GET /components/{id}

Returns a single component.

id: string
in path

Unique ID for the component to retrieve

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

404 Not Found

Object not found, check the id parameter

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "GZ7tIAmLacSDW7sHe9Fskl",
  "project": "ACME",
  "name": "API",
  "group": "System",
  "created_at": "2020-02-07T14:22:03Z",
  "status": "Operational",
  "status_color": "green",
  "description": null,
  "showcased": true
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}
Response Example (404 Not Found)
{
  "detail": "Not found."
}

Incident

Incidents are events that affect your service, which you want to communicate to your users.

List incidents

GET /incidents

Returns a list of all incident events.

200 OK

OK

type
401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "LaPtdb2hXX3447YH7XYrt9",
    "project": "ACME",
    "name": "Database replica connection failure",
    "created_at": "2020-02-03T12:15:58Z",
    "status": "Verifying",
    "affected_components": [
      {
        "id": "GZ7tIAmLacSDW7sHe9Fskl",
        "project": "ACME",
        "name": "API",
        "group": "System",
        "created_at": "2020-02-07T14:22:03Z",
        "status": "Critial state",
        "status_color": "red",
        "description": null,
        "showcased": true
      }
    ],
    "reported_by": "Donald Duck",
    "occurred_at": "2020-03-18T09:02:24Z",
    "message": "<b>Summary</b><br>API can not connect to the database replica.",
    "updates": [
      {
        "id": "LlPtdb4hXX3447YH7XYrt9",
        "created_at": "2020-03-18T09:02:39Z",
        "reported_by": "Huey",
        "status": "Investigating",
        "message": "Our devs are looking into the issue."
      },
      {
        "id": "GkSMzCWZfLZzam9AK4oGKi",
        "created_at": "2020-03-18T09:02:56Z",
        "reported_by": "Dewey",
        "status": "Identified",
        "message": "Our devs have found the issue and researching a solution."
      },
      {
        "id": "J7eS9zJpNbVrXb2FxVuUik",
        "created_at": "2020-03-18T09:03:31Z",
        "reported_by": "Louie",
        "status": "Verifying",
        "message": "A fix has been deployed and our devs are verifying the solution."
      }
    ]
  }
]
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Live incidents

GET /incidents/live

Returns a list of all ongoing incident events that are not resolved.

200 OK

OK

type
401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "LaPtdb2hXX3447YH7XYrt9",
    "project": "ACME",
    "name": "Database replica connection failure",
    "created_at": "2020-02-03T12:15:58Z",
    "status": "Investigating",
    "affected_components": [
      {
        "id": "GZ7tIAmLacSDW7sHe9Fskl",
        "project": "ACME",
        "name": "API",
        "group": "System",
        "created_at": "2020-02-07T14:22:03Z",
        "status": "Critial state",
        "status_color": "red",
        "description": null,
        "showcased": true
      }
    ],
    "reported_by": "Donald Duck",
    "occurred_at": "2020-03-18T09:02:24Z",
    "message": "<b>Summary</b><br>API can not connect to the database replica.",
    "updates": []
  }
]
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Get incident

GET /incidents/{id}

Returns a single incident event.

id: string
in path

Unique ID for the incident event to retrieve

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

404 Not Found

Object not found, check the id parameter

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "LaPtdb2hXX3447YH7XYrt9",
  "project": "ACME",
  "name": "Database replica connection failure",
  "created_at": "2020-02-03T12:15:58Z",
  "status": "Verifying",
  "affected_components": [
    {
      "id": "GZ7tIAmLacSDW7sHe9Fskl",
      "project": "ACME",
      "name": "API",
      "group": "System",
      "created_at": "2020-02-07T14:22:03Z",
      "status": "Critial state",
      "status_color": "red",
      "description": null,
      "showcased": true
    }
  ],
  "reported_by": "Donald Duck",
  "occurred_at": "2020-03-18T09:02:24Z",
  "message": "<b>Summary</b><br>API can not connect to the database replica.",
  "updates": [
    {
      "id": "LlPtdb4hXX3447YH7XYrt9",
      "created_at": "2020-03-18T09:02:39Z",
      "reported_by": "Huey",
      "status": "Investigating",
      "message": "Our devs are looking into the issue."
    },
    {
      "id": "GkSMzCWZfLZzam9AK4oGKi",
      "created_at": "2020-03-18T09:02:56Z",
      "reported_by": "Dewey",
      "status": "Identified",
      "message": "Our devs have found the issue and researching a solution."
    },
    {
      "id": "J7eS9zJpNbVrXb2FxVuUik",
      "created_at": "2020-03-18T09:03:31Z",
      "reported_by": "Louie",
      "status": "Verifying",
      "message": "A fix has been deployed and our devs are verifying the solution."
    }
  ]
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}
Response Example (404 Not Found)
{
  "detail": "Not found."
}

Maintenance

Maintenance are scheduled future planned events that might interrupt your service, which you want to communicate to your users.

List maintenance

GET /maintenances

Returns a list of all maintenance events.

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "k9gVLLPoNgbPA72HQKvy2b",
    "project": "ACME",
    "name": "Database migration",
    "created_at": "2020-02-03T12:15:58Z",
    "status": "In progress",
    "affected_components": [
      {
        "id": "GZ7tIAmLacSDW7sHe9Fskl",
        "project": "ACME",
        "name": "API",
        "group": "System",
        "created_at": "2020-02-07T14:22:03Z",
        "status": "Maintenance mode",
        "status_color": "gray",
        "description": null,
        "showcased": true
      }
    ],
    "reported_by": "Donald Duck",
    "scheduled_for": "2020-02-10T22:00:00Z",
    "ends_at": "2020-02-10T23:00:00Z",
    "message": "Upgrading version of <b>main database</b> from version 9.0 to <strikethrough>10.0</strikethrough> 10.2."
  }
]
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Get maintenance

GET /maintenances/{id}

Returns a single maintenance event.

id: string
in path

Unique ID for the maintenance event to retrieve

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

404 Not Found

Object not found, check the id parameter

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "k9gVLLPoNgbPA72HQKvy2b",
  "project": "ACME",
  "name": "Database migration",
  "created_at": "2020-02-03T12:15:58Z",
  "status": "In progress",
  "affected_components": [
    {
      "id": "GZ7tIAmLacSDW7sHe9Fskl",
      "project": "ACME",
      "name": "API",
      "group": "System",
      "created_at": "2020-02-07T14:22:03Z",
      "status": "Maintenance mode",
      "status_color": "gray",
      "description": null,
      "showcased": true
    }
  ],
  "reported_by": "Donald Duck",
  "scheduled_for": "2020-02-10T22:00:00Z",
  "ends_at": "2020-02-10T23:00:00Z",
  "message": "Upgrading version of <b>main database</b> from version 9.0 to <strikethrough>10.0</strikethrough> 10.2."
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}
Response Example (404 Not Found)
{
  "detail": "Not found."
}

Metrics

Metrics monitored by the service.

List metrics

GET /metrics

Returns a list of all metrics.

200 OK

OK

type
401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "LPGPFfUjHpnJfMXvqnctt7",
    "project": "ACME",
    "name": "API",
    "description": null,
    "created_at": "2020-02-19T16:13:58Z",
    "component": {
      "id": "GZ7tIAmLacSDW7sHe9Fskl",
      "project": "ACME",
      "name": "API",
      "group": "System",
      "created_at": "2020-02-07T14:22:03Z",
      "status": "Maintenance mode",
      "status_color": "gray",
      "description": null,
      "showcased": true
    },
    "url": "https://api.acme.com/health-check",
    "frequency": "5 minutes",
    "location": "US west",
    "showcased": true
  }
]
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Get metric

GET /metrics/{id}

Returns a single metric.

id: string
in path

Unique ID for the metric to retrieve

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

404 Not Found

Object not found, check the id parameter

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "LPGPFfUjHpnJfMXvqnctt7",
  "project": "ACME",
  "name": "API",
  "description": null,
  "created_at": "2020-02-19T16:13:58Z",
  "component": {
    "id": "GZ7tIAmLacSDW7sHe9Fskl",
    "project": "ACME",
    "name": "API",
    "group": "System",
    "created_at": "2020-02-07T14:22:03Z",
    "status": "Maintenance mode",
    "status_color": "gray",
    "description": null,
    "showcased": true
  },
  "url": "https://api.acme.com/health-check",
  "frequency": "5 minutes",
  "location": "US west",
  "showcased": true
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}
Response Example (404 Not Found)
{
  "detail": "Not found."
}

Custom metrics

Metrics where you can customize the unit and submit your own data.

Add data points

POST /custom-metrics/data

Add data points to custom metrics.

Please note the following before submitting data points:

  • Data points must be in UTC.

  • Data points are cast to minutes, removing the seconds.

  • The response data points have the casted values as they are stored.

  • Data points are updated if the specific minute already exists.

  • Data points older than 30 days are discarded.

Data object with data point values to add to custom metrics

Request Example
{
  "data": {
    "29epTBPdfSTBB7LAmTfADw": [
      {
        "timestamp": 1615387895,
        "value": 11.6
      },
      {
        "timestamp": 1615387935,
        "value": 12.1
      }
    ]
  }
}
201 Created

Data points have been created

400 Bad Request

Malformed request body, make sure the formatting matches the request example

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (201 Created)
{
  "29epTBPdfSTBB7LAmTfADw": [
    {
      "timestamp": 1615387860,
      "value": 11.6
    },
    {
      "timestamp": 1615387920,
      "value": 12.1
    }
  ]
}
Response Example (400 Bad Request)
{
  "detail": "Malformed request."
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

List custom metrics

GET /custom-metrics

Returns a list of all custom metrics.

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "29epTBPdfSTBB7LAmTfADw",
    "project": "ACME",
    "name": "Errors",
    "description": null,
    "created_at": "2020-02-03T08:16:39Z",
    "component": {
      "id": "GZ7tIAmLacSDW7sHe9Fskl",
      "project": "ACME",
      "name": "API",
      "group": "System",
      "created_at": "2020-02-07T14:22:03Z",
      "status": "Maintenance mode",
      "status_color": "gray",
      "description": null,
      "showcased": true
    },
    "suffix": "per minutes",
    "rollup": "Max",
    "showcased": true
  }
]
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}

Get custom metric

GET /custom-metrics/{id}

Returns a single custom metric.

id: string
in path

Unique ID for the custom metric to retrieve

200 OK

OK

401 Unauthorized

Unauthorized, missing or invalid API-key, see Authentication

404 Not Found

Object not found, check the id parameter

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "29epTBPdfSTBB7LAmTfADw",
  "project": "ACME",
  "name": "Errors",
  "description": null,
  "created_at": "2020-02-03T08:16:39Z",
  "component": {
    "id": "GZ7tIAmLacSDW7sHe9Fskl",
    "project": "ACME",
    "name": "API",
    "group": "System",
    "created_at": "2020-02-07T14:22:03Z",
    "status": "Maintenance mode",
    "status_color": "gray",
    "description": null,
    "showcased": true
  },
  "suffix": "per minutes",
  "rollup": "Max",
  "showcased": true
}
Response Example (401 Unauthorized)
{
  "detail": "Authentication credentials were not provided."
}
Response Example (404 Not Found)
{
  "detail": "Not found."
}

Schema Definitions

System Status: object

status: string All systems operational, Some systems have issues, All systems down, Under maintenance

Status phrase as shown on the status page.

status_color: string green, orange, red, gray

Human readable color name.

Example
{
  "status": "All systems operational",
  "status_color": "green"
}

Live: object

project: string

Project name.

url: string

Status page URL.

incidents: Incident

A list of ongoing incidents.

Incident
maintenance: Maintenance

A list of maintenance currently in progress.

Maintenance
Example
{
  "project": "ACME",
  "url": "https://acme.pingpong.host",
  "incidents": [],
  "maintenance": [
    {
      "id": "k9gVLLPoNgbPA72HQKvy2b",
      "project": "ACME",
      "name": "Database migration",
      "created_at": "2020-02-03T12:15:58Z",
      "status": "In progress",
      "affected_components": [
        {
          "id": "GZ7tIAmLacSDW7sHe9Fskl",
          "project": "ACME",
          "name": "API",
          "group": "System",
          "created_at": "2020-02-07T14:22:03Z",
          "status": "Maintenance mode",
          "status_color": "gray",
          "description": null,
          "showcased": true
        }
      ],
      "reported_by": "Donald Duck",
      "scheduled_for": "2020-02-10T22:00:00Z",
      "ends_at": "2020-02-10T23:00:00Z",
      "message": "Upgrading version of <b>main database</b> from version 9.0 to <strikethrough>10.0</strikethrough> 10.2."
    }
  ]
}

Component: object

id: uuid (up to 22 chars)

Unique identifier.

project: string (up to 50 chars)

Project name.

name: string (up to 50 chars)

Component name.

group: string

Name of the group it belongs to, or null if it doesn't belong to a group.

created_at: string (date-time)

Datetime when component was created in UTC.

status: string Unknown, Operational, Minor issues, Major issues, Critical state, Maintenance mode, Unavailable

Current status as shown on the status page.

status_color: string green, orange, red

Human readable color name.

description: string (up to 255 chars)

Short description of the component.

showcased: boolean

Whether it is shown on the status page.

Example
{
  "id": "GZ7tIAmLacSDW7sHe9Fskl",
  "project": "ACME",
  "name": "API",
  "group": "System",
  "created_at": "2020-02-07T14:22:03Z",
  "status": "Operational",
  "status_color": "green",
  "description": null,
  "showcased": true
}

Incident: object

id: uuid (up to 22 chars)

Unique identifier.

project: string (up to 50 chars)

Project name.

name: string (up to 50 chars)

Incident name.

created_at: string (date-time)

Datetime when event was created in UTC.

status: string Investigating, Identified, Watching, Verifying, Fixed

Current event status.

affected_components: Component

A list of components affected by this event.

Component
reported_by: string

Name of the person in your team who reported the event.

occurred_at: string (date-time)

When event started in UTC.

message: string (HTML)

What will happen during the maintenance.

updates: object[]
object
id: uuid (up to 22 chars)

Unique identifier.

created_at: string (date-time)

Datetime when event was created in UTC.

status: string Investigating, Identified, Watching, Verifying, Fixed

Current event status.

reported_by: string

Name of the person in your team who reported the event.

message: string (HTML)

What will happen during the maintenance.

Example
{
  "id": "LaPtdb2hXX3447YH7XYrt9",
  "project": "ACME",
  "name": "Database replica connection failure",
  "created_at": "2020-02-03T12:15:58Z",
  "status": "Verifying",
  "affected_components": [
    {
      "id": "GZ7tIAmLacSDW7sHe9Fskl",
      "project": "ACME",
      "name": "API",
      "group": "System",
      "created_at": "2020-02-07T14:22:03Z",
      "status": "Critial state",
      "status_color": "red",
      "description": null,
      "showcased": true
    }
  ],
  "reported_by": "Donald Duck",
  "occurred_at": "2020-03-18T09:02:24Z",
  "message": "<b>Summary</b><br>API can not connect to the database replica.",
  "updates": [
    {
      "id": "LlPtdb4hXX3447YH7XYrt9",
      "created_at": "2020-03-18T09:02:39Z",
      "reported_by": "Huey",
      "status": "Investigating",
      "message": "Our devs are looking into the issue."
    },
    {
      "id": "GkSMzCWZfLZzam9AK4oGKi",
      "created_at": "2020-03-18T09:02:56Z",
      "reported_by": "Dewey",
      "status": "Identified",
      "message": "Our devs have found the issue and researching a solution."
    },
    {
      "id": "J7eS9zJpNbVrXb2FxVuUik",
      "created_at": "2020-03-18T09:03:31Z",
      "reported_by": "Louie",
      "status": "Verifying",
      "message": "A fix has been deployed and our devs are verifying the solution."
    }
  ]
}

Maintenance: object

id: uuid (up to 22 chars)

Unique identifier.

project: string (up to 50 chars)

Project name.

name: string (up to 50 chars)

Maintenance name.

created_at: string (date-time)

Datetime when event was created in UTC.

status: string Upcoming, In progress, Complete

Current event status.

affected_components: Component

A list of components affected by this event.

Component
reported_by: string

Name of the person in your team who reported the event.

scheduled_for: string (date-time)

When event will occur in UTC.

ends_at: string (date-time)

When event will end in UTC.

message: string (HTML)

What will happen during the maintenance.

Example
{
  "id": "k9gVLLPoNgbPA72HQKvy2b",
  "project": "ACME",
  "name": "Database migration",
  "created_at": "2020-02-03T12:15:58Z",
  "status": "In progress",
  "affected_components": [
    {
      "id": "GZ7tIAmLacSDW7sHe9Fskl",
      "project": "ACME",
      "name": "API",
      "group": "System",
      "created_at": "2020-02-07T14:22:03Z",
      "status": "Maintenance mode",
      "status_color": "gray",
      "description": null,
      "showcased": true
    }
  ],
  "reported_by": "Donald Duck",
  "scheduled_for": "2020-02-10T22:00:00Z",
  "ends_at": "2020-02-10T23:00:00Z",
  "message": "Upgrading version of <b>main database</b> from version 9.0 to <strikethrough>10.0</strikethrough> 10.2."
}

Metric: object

id: uuid (up to 22 chars)

Unique identifier.

project: string (up to 50 chars)

Project name.

name: string (up to 50 chars)

Metric name.

description: string (up to 255 chars)

Short description of the metric.

created_at: string (date-time)

Datetime when metric was created in UTC.

component: Component

A component connected to this metric.

url: string

URL to ping.

frequency: string minute, 2 minutes, 5 minutes, 10 minutes, 15 minutes, 30 minutes, 60 minutes

URL is pinged with this frequency.

location: string US west, US east, São Paulo, London, Milan, Stockholm, Singapore, Sydney, Tokyo

URL is pinged from this location.

showcased: boolean

Whether it is shown on the status page.

Example
{
  "id": "LPGPFfUjHpnJfMXvqnctt7",
  "project": "ACME",
  "name": "API",
  "description": null,
  "created_at": "2020-02-19T16:13:58Z",
  "component": {
    "id": "GZ7tIAmLacSDW7sHe9Fskl",
    "project": "ACME",
    "name": "API",
    "group": "System",
    "created_at": "2020-02-07T14:22:03Z",
    "status": "Maintenance mode",
    "status_color": "gray",
    "description": null,
    "showcased": true
  },
  "url": "https://api.acme.com/health-check",
  "frequency": "5 minutes",
  "location": "US west",
  "showcased": true
}

Custom Metric: object

id: uuid (up to 22 chars)

Unique identifier.

project: string (up to 50 chars)

Project name.

name: string (up to 50 chars)

Custom metric name.

description: string (up to 255 chars)

Short description of the custom metric.

created_at: string (date-time)

Datetime when custom metric was created in UTC.

component: Component

A component connected to this custom metric.

suffix: string (up to 50 chars)

Metric unit/suffix.

rollup: string Mean value, Sum of all values, Minimum value, Maximum value

Rollup type.

showcased: boolean

Whether it is shown on the status page.

Example
{
  "id": "29epTBPdfSTBB7LAmTfADw",
  "project": "ACME",
  "name": "Errors",
  "description": null,
  "created_at": "2020-02-03T08:16:39Z",
  "component": {
    "id": "GZ7tIAmLacSDW7sHe9Fskl",
    "project": "ACME",
    "name": "API",
    "group": "System",
    "created_at": "2020-02-07T14:22:03Z",
    "status": "Maintenance mode",
    "status_color": "gray",
    "description": null,
    "showcased": true
  },
  "suffix": "per minutes",
  "rollup": "Max",
  "showcased": true
}

Custom Metric Data: object

data: Metric Data Points

Container for custom metric data points.

Example
{
  "data": {
    "29epTBPdfSTBB7LAmTfADw": [
      {
        "timestamp": 1617786615,
        "value": 11.6
      }
    ]
  }
}

Metric Data Points: object

<metric id>: Data Point

A list of data points.

Data Point
Example
{
  "29epTBPdfSTBB7LAmTfADw": [
    {
      "timestamp": 1615387895,
      "value": 11.6
    },
    {
      "timestamp": 1615819080,
      "value": 12.1
    }
  ]
}

Data Point: object

timestamp: integer (int32)

Timestamp in UTC when data point occurred.

value: integer, float

Data point value.

Example
{
  "timestamp": 1615387895,
  "value": 11.6
}

Auth Error: object

detail: string
Example
{
  "detail": "Authentication credentials were not provided."
}

Parse Error: object

detail: string
Example
{
  "detail": "Malformed request."
}

Not found: object

detail: string
Example
{
  "detail": "Not found."
}