Explore documentation
  1. Welcome to Errors
    1. JavaScript tag
  2. Collecting errors
    1. Integrating using an AI prompt
    2. Sentry SDK
  3. Using the product
    1. Exception grouping
    2. AI prompt
    3. Releases
    4. Uploading source maps
    5. Spike protection
  4. Integrations
    1. Reporting incidents
    2. Slack
    3. Microsoft Teams
    4. Linear
    5. Jira
    6. GitHub
    7. Outgoing webhooks
  5. Errors API
    1. Getting an API token
    2. Applications API
      1. List all applications GET
      2. Get a single application GET
      3. Create an application POST
      4. Update an application PATCH
      5. Remove an application DELETE
    3. Application groups API
    4. Releases API

Get a single application

Retrieves a specific error tracking application by its ID.

GET https://errors.betterstack.com/api/v2/applications/{id}

URL parameters

id
required string

The ID of the application to retrieve.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns the requested application.

Response body

{
  "data": {
    "id": "1234",
    "type": "application",
    "attributes": {
      "application_group_id": 5678,
      "correlate_with_source_id": 9876,
      "github_repository_name": "better-stack/my-app",
      "gitlab_repository_name": null,
      "team_id": 123456,
      "team_name": "example-team",
      "name": "my-web-app",
      "platform": "ruby_errors",
      "table_name": "my_web_app",
      "token": "abc123def456ghi789",
      "js_tag_token": "pMq7kR3nXwT9bY2sF6hJ4dLc",
      "ingesting_paused": false,
      "ingesting_host": "s1234.us-east-9.betterstackdata.com",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z",
      "errors_retention": 90,
      "data_region": "us-east-9",
      "custom_bucket": null,
      "code_mapping_stack_root": "/usr/src/app/",
      "code_mapping_source_root": "apps/backend/",
      "vrl_transformation_exceptions": "._pattern = slice!(sha2(to_string!(.summary.type)), 0, 24)\n.",
      "vrl_transformation_replays": "",
      "vrl_transformation_web_events": ".payload.meta.path = parse_url!(.payload.meta.url).path\n.",
      "vrl_transformation_logs": "",
      "vrl_transformation_spans": ""
    }
  }
}
401

Unauthorized

Response body

{
  "errors": "Invalid authentication"
}
404

Not Found

Response body

{
  "errors": "Resource with the provided ID was not found"
}

Response attributes

id
string

The ID of the application.

type
string

Always application.

attributes.application_group_id
integer or null

The ID of the application group the application is in, or null when it isn't in a group.

attributes.correlate_with_source_id
integer or null

The ID of the Telemetry source the application's errors are correlated with, or null when it isn't correlated.

attributes.github_repository_name
string or null

The full name of the GitHub repository connected to the application, such as owner/repo, or null when none is connected.

attributes.gitlab_repository_name
string or null

The full name of the GitLab repository connected to the application, such as group/project, or null when none is connected.

attributes.team_id
integer

The ID of the team the application belongs to.

attributes.team_name
string

The name of the team the application belongs to.

attributes.name
string

The name of the application.

attributes.platform
string

The platform of the application, such as ruby_errors. Create an application lists every value.

attributes.table_name
string

The application's table name, which identifies its data in SQL queries.

attributes.token
string

The token your SDK uses to send data to the application.

attributes.js_tag_token
string or null

The token of the application's browser JavaScript tag, distinct from token, or null when the application has no JavaScript tag.

attributes.ingesting_paused
boolean

Whether ingesting is paused for the application.

attributes.ingesting_host
string

The host your SDK sends the application's data to.

attributes.created_at
string

When the application was created, as an ISO 8601 date-time in UTC.

attributes.updated_at
string

When the application was last updated, as an ISO 8601 date-time in UTC.

attributes.errors_retention
integer

How many days the application's data is kept.

attributes.data_region
string

The data region or cluster the application's data is stored in, such as us-east-9.

attributes.custom_bucket
object or null

Your own S3-compatible bucket that stores the application's data, or null when it uses Better Stack storage.

attributes.custom_bucket.name
string

The name of the bucket.

attributes.custom_bucket.endpoint
string

The endpoint URL of the bucket.

attributes.custom_bucket.access_key_id
string

The access key ID for the bucket. The secret access key is never returned.

attributes.custom_bucket.keep_data_after_retention
boolean

Whether data stays in the bucket after the retention period ends.

attributes.code_mapping_stack_root
string or null

The absolute path to the root of the stack trace on your server, such as /usr/src/app/, or null when not set.

attributes.code_mapping_source_root
string or null

The path from your project's root to the deployed source code, such as apps/backend/, or null when not set.

attributes.vrl_transformation_exceptions
string

The VRL code that groups incoming exceptions into errors, including the platform's default grouping, or an empty string when there is none.

attributes.vrl_transformation_replays
string

The VRL code applied to session replays during ingestion, or an empty string when there is none.

attributes.vrl_transformation_web_events
string

The VRL code applied to web events like page views and web vitals during ingestion, or an empty string when there is none.

attributes.vrl_transformation_logs
string

The VRL code applied to logs during ingestion, or an empty string when there is none.

attributes.vrl_transformation_spans
string

The VRL code applied to spans during ingestion, or an empty string when there is none.

Example cURL

Example
curl --request GET \
  --url https://errors.betterstack.com/api/v2/applications/1234 \
  --header "Authorization: Bearer $TOKEN"


Previous article

List all applications

Next article

Create an application