Language

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

Datadog Site

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

Get a case view

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/views/{view_id}https://api.ap2.datadoghq.com/api/v2/cases/views/{view_id}https://api.datadoghq.eu/api/v2/cases/views/{view_id}https://api.ddog-gov.com/api/v2/cases/views/{view_id}https://api.us2.ddog-gov.com/api/v2/cases/views/{view_id}https://api.datadoghq.com/api/v2/cases/views/{view_id}https://api.us3.datadoghq.com/api/v2/cases/views/{view_id}https://api.us5.datadoghq.com/api/v2/cases/views/{view_id}

Overview

Returns a single saved case view identified by its UUID, including its query, associated project, and timestamps.

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

Arguments

Path Parameters

Name

Type

Description

view_id [required]

string

The UUID of the case view.

Response

OK

Response containing a single case view.

Expand All

Field

Type

Description

data [required]

object

A saved case view that provides a filtered, reusable list of cases matching a specific query. Views act as persistent dashboards for monitoring case subsets.

attributes [required]

object

Attributes of a case view, including the filter query and optional notification rule.

created_at [required]

date-time

Timestamp when the view was created.

modified_at

date-time

Timestamp when the view was last modified.

name [required]

string

A human-readable name for the view, displayed in the Case Management UI.

np_rule_id

string

The identifier of a notification rule linked to this view. When set, users subscribed to the view receive alerts for matching cases.

query [required]

string

The search query that determines which cases appear in this view. Uses the same syntax as the Case Management search bar (for example, status:open priority:P1).

id [required]

string

The view's identifier.

relationships

object

Related resources for the case view, including the creator, last modifier, and associated project.

created_by

object

Relationship to user.

data [required]

object

Relationship to user object.

id [required]

string

A unique identifier that represents the user.

type [required]

enum

User resource type. Allowed enum values: user

default: user

modified_by

object

Relationship to user.

data [required]

object

Relationship to user object.

id [required]

string

A unique identifier that represents the user.

type [required]

enum

User resource type. Allowed enum values: user

default: user

project

object

Relationship to project.

data [required]

object

Relationship to project object.

id [required]

string

A unique identifier that represents the project.

type [required]

enum

Project resource type. Allowed enum values: project

default: project

type [required]

enum

JSON:API resource type for case views. Allowed enum values: view

default: view

{
  "data": {
    "attributes": {
      "created_at": "2024-01-01T00:00:00.000Z",
      "modified_at": "2019-09-19T10:00:00.000Z",
      "name": "Open bugs",
      "np_rule_id": "string",
      "query": "status:open type:bug"
    },
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "relationships": {
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "project": {
        "data": {
          "id": "e555e290-ed65-49bd-ae18-8acbfcf18db7",
          "type": "project"
        }
      }
    },
    "type": "view"
  }
}

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 view_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
# 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/views/${view_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"