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/v5/incidents/{incident_id}/timeline

URL parameters

incident_id
required string

Headers

Authorization
required string
200

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",
              "email": "john@smith.com"
            }
          },
          "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

id
string
type
string
attributes.item_type
string
attributes.at
string or null
attributes.data
object
attributes.data.title
string or null
attributes.data.content
string
attributes.data.content.text
string
attributes.data.content.user
object or null
attributes.data.content.user.id
integer or null
attributes.data.content.user.name
string
attributes.data.content.user.email
string or null
attributes.data.links
array of strings
attributes.data.attachments
array of objects
attributes.data.attachments[].filename
string
attributes.data.attachments[].size
integer
attributes.data.attachments[].mime_type
string
attributes.data.attachments[].url
string

Example cURL

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