Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Get case timeline

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/cases/{case_id}/timelineshttps://api.ap2.datadoghq.com/api/v2/cases/{case_id}/timelineshttps://api.datadoghq.eu/api/v2/cases/{case_id}/timelineshttps://api.ddog-gov.com/api/v2/cases/{case_id}/timelineshttps://api.us2.ddog-gov.com/api/v2/cases/{case_id}/timelineshttps://api.datadoghq.com/api/v2/cases/{case_id}/timelineshttps://api.us3.datadoghq.com/api/v2/cases/{case_id}/timelineshttps://api.us5.datadoghq.com/api/v2/cases/{case_id}/timelines

Overview

Returns the timeline of events for a case, including comments, status changes, and other activity. Supports pagination and sort order.

OAuth apps require the cases_read authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

case_id [required]

string

Case’s UUID or key

Query Strings

Name

Type

Description

page[size]

integer

Number of timeline cells to return per page.

page[number]

integer

Zero-based page number for pagination.

sort[ascending]

boolean

If true, returns timeline cells in chronological order (oldest first). Defaults to false (newest first).

Response

OK

Response containing the chronological list of timeline cells for a case.

Expand All

Field

Type

Description

data

[object]

The TimelineResponse data.

attributes [required]

object

Attributes of a timeline cell, representing a single event in a case's chronological activity log (for example, a comment, status change, or assignment update).

author

 <oneOf>

The author of the timeline cell. Currently only user authors are supported.

Option 1

object

A user who authored a timeline cell.

content

object

Profile information for the user who authored the timeline cell.

email

string

The email address of the user.

handle

string

The Datadog handle of the user.

id

string

The UUID of the user.

name

string

The display name of the user.

type

enum

The type of timeline cell author. Currently only USER is supported. Allowed enum values: USER

cell_content

 <oneOf>

The content payload of a timeline cell, varying by cell type.

Option 1

object

The content of a comment timeline cell.

message

string

The text content of the comment. Supports Markdown formatting.

created_at

date-time

Timestamp of when the cell was created

deleted_at

date-time

Timestamp of when the cell was deleted

modified_at

date-time

Timestamp of when the cell was last modified

type

enum

The type of content in the timeline cell. Currently only COMMENT is supported in this endpoint. Allowed enum values: COMMENT

id [required]

string

Timeline cell's identifier

type [required]

enum

JSON:API resource type for timeline cells. Allowed enum values: timeline_cell

default: timeline_cell

{
  "data": [
    {
      "attributes": {
        "author": {
          "content": {
            "email": "string",
            "handle": "string",
            "id": "string",
            "name": "string"
          },
          "type": "USER"
        },
        "cell_content": {
          "message": "string"
        },
        "created_at": "2019-09-19T10:00:00.000Z",
        "deleted_at": "2019-09-19T10:00:00.000Z",
        "modified_at": "2019-09-19T10:00:00.000Z",
        "type": "COMMENT"
      },
      "id": "aeadc05e-98a8-11ec-ac2c-da7ad0900001",
      "type": "timeline_cell"
    }
  ]
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Unauthorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Path parameters
export case_id="f98a5a5b-e0ff-45d4-b2f5-afe6e74de504"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/cases/${case_id}/timelines" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"