List incident timeline

Returns a list of timeline items for the given incident. This endpoint does not support pagination and returns all timeline items instead.

GET https://incidents.betterstack.com/api/v3/incidents/{incident_id}/timeline

URL parameters

incident_id

required string

The ID of the incident you want to get

Headers

Authorization

required string

Bearer $TOKEN

200

The structure of the data attribute of the timeline item depends on the item type. The item_type can have these values:
- generic
- generic_card
- timeline_truncated
- response_item
- payload
- comment
- status_report_card
- ai_sre

Response body

{
  "data": [
    {
      "id": "123-timeline_truncated",
      "type": "timeline_item",
      "attributes": {
        "item_type": "timeline_truncated",
        "at": null,
        "data": {
          "title": "Skipping 123 timeline events"
        }
      }
    },
    {
      "id": "23",
      "type": "timeline_item",
      "attributes": {
        "item_type": "comment",
        "at": "2021-02-12T10:44:46.618Z",
        "data": {
          "title": null,
          "content": {
            "text": "Some comment with attachment",
            "user": {
              "id": 123,
              "name": "John Smith"
            }
          },
          "attachments": [
            {
              "size": 44369,
              "filename": "Screenshot 2021-02-12 at 10.44.45.png",
              "mime_type": "image/png",
              "url": "https://some-storage.s3.amazonaws.com/attachments/abc123.png"
            }
          ]
        }
      }
    },
    {
      "id": "status-report-123-update-456",
      "type": "timeline_item",
      "attributes": {
        "item_type": "status_report_card",
        "at": "2021-02-12T08:15:00.000Z",
        "data": {
          "title": "Status page (status.example.com): API is down",
          "content": "API went down.",
          "links": [
            "https://status.example.com/incident/123"
          ]
        }
      }
    },
    {
      "id": "107107309",
      "type": "timeline_item",
      "attributes": {
        "item_type": "generic_card",
        "at": "2021-02-12T07:49:14.539Z",
        "data": {
          "title": "Some title",
          "content": "John Smith opened the incident email sent to john@smith.com.",
          "links": [
            "https://uptime.betterstack.com/team/1/team-members/1"
          ]
        }
      }
    },
    {
      "id": "2470302-content-response",
      "type": "timeline_item",
      "attributes": {
        "item_type": "response_item",
        "at": "2021-02-12T06:42:25.905Z",
        "data": {
          "title": "Page response",
          "content": "[\"Some response data\"]"
        }
      }
    },
    {
      "id": "2107504",
      "type": "timeline_item",
      "attributes": {
        "item_type": "payload",
        "at": "2021-02-11T07:52:57.540Z",
        "data": {
          "title": "Datadog",
          "content": "Datadog alert.",
          "attachments": [
            {
              "size": 123456,
              "filename": "File.png",
              "mime_type": "image/png",
              "url": "https://some-storage.s3.amazonaws.com/attachments/xyz123.png"
            }
          ]
        }
      }
    },
    {
      "id": "incident-started",
      "type": "timeline_item",
      "attributes": {
        "item_type": "generic",
        "at": "2021-02-10T04:02:57.755Z",
        "data": {
          "content": "Incident started.",
          "links": []
        }
      }
    }
  ]
}

Response attributes

string

The ID of the timeline item.

type

string

Always timeline_item.

attributes.item_type

string

What kind of item it is, which decides the fields in data: generic, generic_card, timeline_truncated, response_item, payload, comment, status_report_card, or ai_sre.

attributes.at

string or null

When the item happened, in ISO 8601 format, or null on a timeline_truncated item.

attributes.data

object

The content of the item, shaped by item_type.

attributes.data.title

string or null

The heading of the item, such as the integration name on a payload or the subtitle on a comment, null when there is none and left out on generic and ai_sre items.

attributes.data.content

string

The plain text of the item, an object on a comment and left out on a timeline_truncated item.

attributes.data.content.text

string

The text of the comment, on comment items.

attributes.data.content.user.id

integer or null

The ID of the user who posted the comment, or null when no user posted it.

attributes.data.content.user.name

string or null

The name shown as the author of the comment, which is a label such as Comment added using API when no user posted it, or null when there is no author.

attributes.data.links

array

The URLs in the item, on generic, generic_card, status_report_card, and ai_sre items.

attributes.data.attachments

array

The files attached to a comment or payload item, empty when there are none.

attributes.data.attachments[].filename

string

The name of the file.

attributes.data.attachments[].size

integer

The size of the file in bytes.

attributes.data.attachments[].mime_type

string

The MIME type of the file.

attributes.data.attachments[].url

string

The URL to download the file from.

Example cURL

Example

Copied!

curl --request GET \
  --url https://incidents.betterstack.com/api/v3/incidents/123456789/timeline \
  --header "Authorization: Bearer $TOKEN"

Get incident

Create incident

Explore documentation

List incident timeline

Example cURL

Please accept cookies