Getting started with Errors API

How Errors API works

Our API follows the JSON:API specification.

API requests made to Better Stack API are authorized using a Bearer Authentication standard. That means you'll only need to add a header with Authorization: Bearer $TOKEN to your requests. To access the Errors API, you need an API token. This token authenticates your requests and grants you access to manage your resources programmatically. The Errors API uses the same tokens as the Telemetry API.

You can use either a Global API token (for organization-wide management) or a Telemetry API token (scoped to a specific team).

Get a global API token

A global API token is a token valid across all your teams, for managing anything within Better Stack.

• Go to Better Stack → API tokens.
• Copy an existing token or create a new one in the Global API tokens section.

Get a Telemetry API token

A Telemetry API token is a team-scoped token for managing your Telemetry resources, including Errors. You can get a separate API token for each of your teams.

• Go to Better Stack → API tokens -> Team-based tokens.
• Select your team.
• Copy an existing token or create a new one in the Telemetry API tokens section.

Pagination

Lists come in pages, with a pagination object in the response body. To go through every page, request the URL in pagination.next until it's null. To get a specific page, pass the page query parameter.

curl --request GET \
  --url "https://errors.betterstack.com/api/v2/applications?page=3&per_page=20" \
  --header "Authorization: Bearer $TOKEN"

{
  "data": [
    {
      "id": "41",
      "type": "application",
      "attributes": {
        application's attributes omitted...
      }
    },
    {
      "id": "42",
      "type": "application",
      "attributes": {
        application's attributes omitted...
      }
    }
  ],
  "pagination": {
    "first": "https://errors.betterstack.com/api/v2/applications?page=1&per_page=20",
    "last": "https://errors.betterstack.com/api/v2/applications?page=3&per_page=20",
    "prev": "https://errors.betterstack.com/api/v2/applications?page=2&per_page=20",
    "next": null
  }
}