Language

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

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED

Error Tracking

View and manage issues within Error Tracking. See the Error Tracking page for more information.

Search error tracking issues

POST https://api.ap1.datadoghq.com/api/v2/error-tracking/issues/searchhttps://api.ap2.datadoghq.com/api/v2/error-tracking/issues/searchhttps://api.datadoghq.eu/api/v2/error-tracking/issues/searchhttps://api.ddog-gov.com/api/v2/error-tracking/issues/searchhttps://api.datadoghq.com/api/v2/error-tracking/issues/searchhttps://api.us3.datadoghq.com/api/v2/error-tracking/issues/searchhttps://api.us5.datadoghq.com/api/v2/error-tracking/issues/search

Overview

Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request.

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

Arguments

Query Strings

Name

Type

Description

include

array

Comma-separated list of relationship objects that should be included in the response.

Request

Body Data (required)

Search issues request payload.

Expand All

Field

Type

Description

data [required]

object

Search issues request.

attributes [required]

object

Object describing a search issue request.

from [required]

int64

Start date (inclusive) of the query in milliseconds since the Unix epoch.

order_by

enum

The attribute to sort the search results by. Allowed enum values: TOTAL_COUNT,FIRST_SEEN,IMPACTED_SESSIONS,PRIORITY

persona

enum

Persona for the search. Either track(s) or persona(s) must be specified. Allowed enum values: ALL,BROWSER,MOBILE,BACKEND

query [required]

string

Search query following the event search syntax.

to [required]

int64

End date (exclusive) of the query in milliseconds since the Unix epoch.

track

enum

Track of the events to query. Either track(s) or persona(s) must be specified. Allowed enum values: trace,logs,rum

type [required]

enum

Type of the object. Allowed enum values: search_request

{
  "data": {
    "attributes": {
      "query": "service:orders-* AND @language:go",
      "from": 1671612804000,
      "to": 1671620004000,
      "track": "trace"
    },
    "type": "search_request"
  }
}

Response

OK

Search issues response payload.

Expand All

Field

Type

Description

data

[object]

Array of results matching the search query.

attributes [required]

object

Object containing the information of a search result.

impacted_sessions

int64

Count of sessions impacted by the issue over the queried time window.

impacted_users

int64

Count of users impacted by the issue over the queried time window.

total_count

int64

Total count of errors that match the issue over the queried time window.

id [required]

string

Search result identifier (matches the nested issue's identifier).

relationships

object

Relationships between the search result and other resources.

issue

object

Relationship between the search result and the corresponding issue.

data [required]

object

The issue the search result corresponds to.

id [required]

string

Issue identifier.

type [required]

enum

Type of the object. Allowed enum values: issue

type [required]

enum

Type of the object. Allowed enum values: error_tracking_search_result

included

[ <oneOf>]

Array of resources related to the search results.

Option 1

object

The issue matching the request.

attributes [required]

object

Object containing the information of an issue.

error_message

string

Error message associated with the issue.

error_type

string

Type of the error that matches the issue.

file_path

string

Path of the file where the issue occurred.

first_seen

int64

Timestamp of the first seen error in milliseconds since the Unix epoch.

first_seen_version

string

The application version (for example, git commit hash) where the issue was first observed.

function_name

string

Name of the function where the issue occurred.

is_crash

boolean

Error is a crash.

languages

[string]

Array of programming languages associated with the issue.

last_seen

int64

Timestamp of the last seen error in milliseconds since the Unix epoch.

last_seen_version

string

The application version (for example, git commit hash) where the issue was last observed.

platform

enum

Platform associated with the issue. Allowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

service

string

Service name.

state

enum

State of the issue Allowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

id [required]

string

Issue identifier.

relationships

object

Relationship between the issue and an assignee, case and/or teams.

assignee

object

Relationship between the issue and assignee.

data [required]

object

The user the issue is assigned to.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

case

object

Relationship between the issue and case.

data [required]

object

The case the issue is attached to.

id [required]

string

Case identifier.

type [required]

enum

Type of the object. Allowed enum values: case

team_owners

object

Relationship between the issue and teams.

data [required]

[object]

Array of teams that are owners of the issue.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

type [required]

enum

Type of the object. Allowed enum values: issue

Option 2

object

A case

attributes [required]

object

Case resource attributes

archived_at

date-time

Timestamp of when the case was archived

attributes

object

The definition of CaseObjectAttributes object.

<any-key>

[string]

closed_at

date-time

Timestamp of when the case was closed

created_at

date-time

Timestamp of when the case was created

description

string

Description

jira_issue

object

Jira issue attached to case

result

object

Jira issue information

issue_id

string

Jira issue ID

issue_key

string

Jira issue key

issue_url

string

Jira issue URL

project_key

string

Jira project key

status

enum

Case status Allowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

key

string

Key

modified_at

date-time

Timestamp of when the case was last modified

priority

enum

Case priority Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

service_now_ticket

object

ServiceNow ticket attached to case

result

object

ServiceNow ticket information

sys_target_link

string

Link to the Incident created on ServiceNow

status

enum

Case status Allowed enum values: IN_PROGRESS,COMPLETED,FAILED

default: IN_PROGRESS

status

enum

Case status Allowed enum values: OPEN,IN_PROGRESS,CLOSED

title

string

Title

type

enum

Case type Allowed enum values: STANDARD

id [required]

string

Case's identifier

relationships

object

Resources related to a case

assignee

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

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

Case resource type Allowed enum values: case

default: case

Option 3

object

The user to whom the issue is assigned.

attributes [required]

object

Object containing the information of a user.

email

string

Email of the user.

handle

string

Handle of the user.

name

string

Name of the user.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

Option 4

object

A team that owns an issue.

attributes [required]

object

Object containing the information of a team.

handle

string

The team's identifier.

name

string

The name of the team.

summary

string

A brief summary of the team, derived from its description.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

{
  "data": [
    {
      "attributes": {
        "impacted_sessions": 12,
        "impacted_users": 4,
        "total_count": 82
      },
      "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
      "relationships": {
        "issue": {
          "data": {
            "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
            "type": "issue"
          }
        }
      },
      "type": "error_tracking_search_result"
    }
  ],
  "included": [
    {
      "attributes": {
        "error_message": "object of type 'NoneType' has no len()",
        "error_type": "builtins.TypeError",
        "file_path": "/django-email/conduit/apps/core/utils.py",
        "first_seen": 1671612804001,
        "first_seen_version": "aaf65cd0",
        "function_name": "filter_forbidden_tags",
        "is_crash": false,
        "languages": [
          "PYTHON",
          "GO"
        ],
        "last_seen": 1671620003100,
        "last_seen_version": "b6199f80",
        "platform": "BACKEND",
        "service": "email-api-py",
        "state": "RESOLVED"
      },
      "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
      "relationships": {
        "assignee": {
          "data": {
            "id": "87cb11a0-278c-440a-99fe-701223c80296",
            "type": "user"
          }
        },
        "case": {
          "data": {
            "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "type": "case"
          }
        },
        "team_owners": {
          "data": [
            {
              "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a",
              "type": "team"
            }
          ]
        }
      },
      "type": "issue"
    }
  ]
}

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"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                          # Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/error-tracking/issues/search" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "query": "service:orders-* AND @language:go",
      "from": 1671612804000,
      "to": 1671620004000,
      "track": "trace"
    },
    "type": "search_request"
  }
}
EOF

Get the details of an error tracking issue

GET https://api.ap1.datadoghq.com/api/v2/error-tracking/issues/{issue_id}https://api.ap2.datadoghq.com/api/v2/error-tracking/issues/{issue_id}https://api.datadoghq.eu/api/v2/error-tracking/issues/{issue_id}https://api.ddog-gov.com/api/v2/error-tracking/issues/{issue_id}https://api.datadoghq.com/api/v2/error-tracking/issues/{issue_id}https://api.us3.datadoghq.com/api/v2/error-tracking/issues/{issue_id}https://api.us5.datadoghq.com/api/v2/error-tracking/issues/{issue_id}

Overview

Retrieve the full details for a specific error tracking issue, including attributes and relationships.

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

Arguments

Path Parameters

Name

Type

Description

issue_id [required]

string

The identifier of the issue.

Query Strings

Name

Type

Description

include

array

Comma-separated list of relationship objects that should be included in the response.

Response

OK

Response containing error tracking issue data.

Expand All

Field

Type

Description

data

object

The issue matching the request.

attributes [required]

object

Object containing the information of an issue.

error_message

string

Error message associated with the issue.

error_type

string

Type of the error that matches the issue.

file_path

string

Path of the file where the issue occurred.

first_seen

int64

Timestamp of the first seen error in milliseconds since the Unix epoch.

first_seen_version

string

The application version (for example, git commit hash) where the issue was first observed.

function_name

string

Name of the function where the issue occurred.

is_crash

boolean

Error is a crash.

languages

[string]

Array of programming languages associated with the issue.

last_seen

int64

Timestamp of the last seen error in milliseconds since the Unix epoch.

last_seen_version

string

The application version (for example, git commit hash) where the issue was last observed.

platform

enum

Platform associated with the issue. Allowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

service

string

Service name.

state

enum

State of the issue Allowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

id [required]

string

Issue identifier.

relationships

object

Relationship between the issue and an assignee, case and/or teams.

assignee

object

Relationship between the issue and assignee.

data [required]

object

The user the issue is assigned to.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

case

object

Relationship between the issue and case.

data [required]

object

The case the issue is attached to.

id [required]

string

Case identifier.

type [required]

enum

Type of the object. Allowed enum values: case

team_owners

object

Relationship between the issue and teams.

data [required]

[object]

Array of teams that are owners of the issue.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

type [required]

enum

Type of the object. Allowed enum values: issue

included

[ <oneOf>]

Array of resources related to the issue.

Option 1

object

The case attached to the issue.

attributes [required]

object

Object containing the information of a case.

archived_at

date-time

Timestamp of when the case was archived.

closed_at

date-time

Timestamp of when the case was closed.

created_at

date-time

Timestamp of when the case was created.

creation_source

string

Source of the case creation.

description

string

Description of the case.

due_date

string

Due date of the case.

insights

[object]

Insights of the case.

ref

string

Reference of the insight.

resource_id

string

Insight identifier.

type

string

Type of the insight.

jira_issue

object

Jira issue of the case.

result

object

Contains the identifiers and URL for a successfully created Jira issue.

issue_id

string

Jira issue identifier.

issue_key

string

Jira issue key.

issue_url

string

Jira issue URL.

project_key

string

Jira project key.

status

string

Creation status of the Jira issue.

key

string

Key of the case.

modified_at

date-time

Timestamp of when the case was last modified.

priority

enum

Case priority Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

status

enum

Case status Allowed enum values: OPEN,IN_PROGRESS,CLOSED

title

string

Title of the case.

type

string

Type of the case.

id [required]

string

Case identifier.

relationships

object

Resources related to a case.

assignee

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

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

Type of the object. Allowed enum values: case

Option 2

object

The user to whom the issue is assigned.

attributes [required]

object

Object containing the information of a user.

email

string

Email of the user.

handle

string

Handle of the user.

name

string

Name of the user.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

Option 3

object

A team that owns an issue.

attributes [required]

object

Object containing the information of a team.

handle

string

The team's identifier.

name

string

The name of the team.

summary

string

A brief summary of the team, derived from its description.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

{
  "data": {
    "attributes": {
      "error_message": "object of type 'NoneType' has no len()",
      "error_type": "builtins.TypeError",
      "file_path": "/django-email/conduit/apps/core/utils.py",
      "first_seen": 1671612804001,
      "first_seen_version": "aaf65cd0",
      "function_name": "filter_forbidden_tags",
      "is_crash": false,
      "languages": [
        "PYTHON",
        "GO"
      ],
      "last_seen": 1671620003100,
      "last_seen_version": "b6199f80",
      "platform": "BACKEND",
      "service": "email-api-py",
      "state": "RESOLVED"
    },
    "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
    "relationships": {
      "assignee": {
        "data": {
          "id": "87cb11a0-278c-440a-99fe-701223c80296",
          "type": "user"
        }
      },
      "case": {
        "data": {
          "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
          "type": "case"
        }
      },
      "team_owners": {
        "data": [
          {
            "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a",
            "type": "team"
          }
        ]
      }
    },
    "type": "issue"
  },
  "included": [
    {
      "attributes": {
        "archived_at": "2025-01-01T00:00:00Z",
        "closed_at": "2025-01-01T00:00:00Z",
        "created_at": "2025-01-01T00:00:00Z",
        "creation_source": "ERROR_TRACKING",
        "description": "string",
        "due_date": "2025-01-01",
        "insights": [
          {
            "ref": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "resource_id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "type": "ERROR_TRACKING"
          }
        ],
        "jira_issue": {
          "result": {
            "issue_id": "1904866",
            "issue_key": "ET-123",
            "issue_url": "https://your-jira-instance.atlassian.net/browse/ET-123",
            "project_key": "ET"
          },
          "status": "COMPLETED"
        },
        "key": "ET-123",
        "modified_at": "2025-01-01T00:00:00Z",
        "priority": "NOT_DEFINED",
        "status": "OPEN",
        "title": "Error: HTTP error",
        "type": "ERROR_TRACKING_ISSUE"
      },
      "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
      "relationships": {
        "assignee": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        },
        "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": "case"
    }
  ]
}

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 issue_id="c1726a66-1f64-11ee-b338-da7ad0900002"
# 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.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/error-tracking/issues/${issue_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Update the state of an issue

PUT https://api.ap1.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/statehttps://api.ap2.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/statehttps://api.datadoghq.eu/api/v2/error-tracking/issues/{issue_id}/statehttps://api.ddog-gov.com/api/v2/error-tracking/issues/{issue_id}/statehttps://api.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/statehttps://api.us3.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/statehttps://api.us5.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/state

Overview

Update the state of an issue by issue_id. Use this endpoint to move an issue between states such as OPEN, RESOLVED, or IGNORED.

OAuth apps require the error_tracking_read, error_tracking_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

issue_id [required]

string

The identifier of the issue.

Request

Body Data (required)

Update issue state request payload.

Expand All

Field

Type

Description

data [required]

object

Update issue state request.

attributes [required]

object

Object describing an issue state update request.

state [required]

enum

State of the issue Allowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

id [required]

string

Issue identifier.

type [required]

enum

Type of the object. Allowed enum values: error_tracking_issue

{
  "data": {
    "attributes": {
      "state": "RESOLVED"
    },
    "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
    "type": "error_tracking_issue"
  }
}

Response

OK

Response containing error tracking issue data.

Expand All

Field

Type

Description

data

object

The issue matching the request.

attributes [required]

object

Object containing the information of an issue.

error_message

string

Error message associated with the issue.

error_type

string

Type of the error that matches the issue.

file_path

string

Path of the file where the issue occurred.

first_seen

int64

Timestamp of the first seen error in milliseconds since the Unix epoch.

first_seen_version

string

The application version (for example, git commit hash) where the issue was first observed.

function_name

string

Name of the function where the issue occurred.

is_crash

boolean

Error is a crash.

languages

[string]

Array of programming languages associated with the issue.

last_seen

int64

Timestamp of the last seen error in milliseconds since the Unix epoch.

last_seen_version

string

The application version (for example, git commit hash) where the issue was last observed.

platform

enum

Platform associated with the issue. Allowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

service

string

Service name.

state

enum

State of the issue Allowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

id [required]

string

Issue identifier.

relationships

object

Relationship between the issue and an assignee, case and/or teams.

assignee

object

Relationship between the issue and assignee.

data [required]

object

The user the issue is assigned to.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

case

object

Relationship between the issue and case.

data [required]

object

The case the issue is attached to.

id [required]

string

Case identifier.

type [required]

enum

Type of the object. Allowed enum values: case

team_owners

object

Relationship between the issue and teams.

data [required]

[object]

Array of teams that are owners of the issue.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

type [required]

enum

Type of the object. Allowed enum values: issue

included

[ <oneOf>]

Array of resources related to the issue.

Option 1

object

The case attached to the issue.

attributes [required]

object

Object containing the information of a case.

archived_at

date-time

Timestamp of when the case was archived.

closed_at

date-time

Timestamp of when the case was closed.

created_at

date-time

Timestamp of when the case was created.

creation_source

string

Source of the case creation.

description

string

Description of the case.

due_date

string

Due date of the case.

insights

[object]

Insights of the case.

ref

string

Reference of the insight.

resource_id

string

Insight identifier.

type

string

Type of the insight.

jira_issue

object

Jira issue of the case.

result

object

Contains the identifiers and URL for a successfully created Jira issue.

issue_id

string

Jira issue identifier.

issue_key

string

Jira issue key.

issue_url

string

Jira issue URL.

project_key

string

Jira project key.

status

string

Creation status of the Jira issue.

key

string

Key of the case.

modified_at

date-time

Timestamp of when the case was last modified.

priority

enum

Case priority Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

status

enum

Case status Allowed enum values: OPEN,IN_PROGRESS,CLOSED

title

string

Title of the case.

type

string

Type of the case.

id [required]

string

Case identifier.

relationships

object

Resources related to a case.

assignee

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

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

Type of the object. Allowed enum values: case

Option 2

object

The user to whom the issue is assigned.

attributes [required]

object

Object containing the information of a user.

email

string

Email of the user.

handle

string

Handle of the user.

name

string

Name of the user.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

Option 3

object

A team that owns an issue.

attributes [required]

object

Object containing the information of a team.

handle

string

The team's identifier.

name

string

The name of the team.

summary

string

A brief summary of the team, derived from its description.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

{
  "data": {
    "attributes": {
      "error_message": "object of type 'NoneType' has no len()",
      "error_type": "builtins.TypeError",
      "file_path": "/django-email/conduit/apps/core/utils.py",
      "first_seen": 1671612804001,
      "first_seen_version": "aaf65cd0",
      "function_name": "filter_forbidden_tags",
      "is_crash": false,
      "languages": [
        "PYTHON",
        "GO"
      ],
      "last_seen": 1671620003100,
      "last_seen_version": "b6199f80",
      "platform": "BACKEND",
      "service": "email-api-py",
      "state": "RESOLVED"
    },
    "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
    "relationships": {
      "assignee": {
        "data": {
          "id": "87cb11a0-278c-440a-99fe-701223c80296",
          "type": "user"
        }
      },
      "case": {
        "data": {
          "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
          "type": "case"
        }
      },
      "team_owners": {
        "data": [
          {
            "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a",
            "type": "team"
          }
        ]
      }
    },
    "type": "issue"
  },
  "included": [
    {
      "attributes": {
        "archived_at": "2025-01-01T00:00:00Z",
        "closed_at": "2025-01-01T00:00:00Z",
        "created_at": "2025-01-01T00:00:00Z",
        "creation_source": "ERROR_TRACKING",
        "description": "string",
        "due_date": "2025-01-01",
        "insights": [
          {
            "ref": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "resource_id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "type": "ERROR_TRACKING"
          }
        ],
        "jira_issue": {
          "result": {
            "issue_id": "1904866",
            "issue_key": "ET-123",
            "issue_url": "https://your-jira-instance.atlassian.net/browse/ET-123",
            "project_key": "ET"
          },
          "status": "COMPLETED"
        },
        "key": "ET-123",
        "modified_at": "2025-01-01T00:00:00Z",
        "priority": "NOT_DEFINED",
        "status": "OPEN",
        "title": "Error: HTTP error",
        "type": "ERROR_TRACKING_ISSUE"
      },
      "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
      "relationships": {
        "assignee": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        },
        "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": "case"
    }
  ]
}

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 issue_id="c1726a66-1f64-11ee-b338-da7ad0900002"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/error-tracking/issues/${issue_id}/state" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "state": "RESOLVED"
    },
    "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
    "type": "error_tracking_issue"
  }
}
EOF

Update the assignee of an issue

PUT https://api.ap1.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/assigneehttps://api.ap2.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/assigneehttps://api.datadoghq.eu/api/v2/error-tracking/issues/{issue_id}/assigneehttps://api.ddog-gov.com/api/v2/error-tracking/issues/{issue_id}/assigneehttps://api.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/assigneehttps://api.us3.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/assigneehttps://api.us5.datadoghq.com/api/v2/error-tracking/issues/{issue_id}/assignee

Overview

Update the assignee of an issue by issue_id.

OAuth apps require the error_tracking_read, error_tracking_write, cases_read, cases_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name

Type

Description

issue_id [required]

string

The identifier of the issue.

Request

Body Data (required)

Update issue assignee request payload.

Expand All

Field

Type

Description

data [required]

object

Update issue assignee request.

id [required]

string

User identifier.

type [required]

enum

Type of the object. Allowed enum values: assignee

{
  "data": {
    "id": "87cb11a0-278c-440a-99fe-701223c80296",
    "type": "assignee"
  }
}

Response

OK

Response containing error tracking issue data.

Expand All

Field

Type

Description

data

object

The issue matching the request.

attributes [required]

object

Object containing the information of an issue.

error_message

string

Error message associated with the issue.

error_type

string

Type of the error that matches the issue.

file_path

string

Path of the file where the issue occurred.

first_seen

int64

Timestamp of the first seen error in milliseconds since the Unix epoch.

first_seen_version

string

The application version (for example, git commit hash) where the issue was first observed.

function_name

string

Name of the function where the issue occurred.

is_crash

boolean

Error is a crash.

languages

[string]

Array of programming languages associated with the issue.

last_seen

int64

Timestamp of the last seen error in milliseconds since the Unix epoch.

last_seen_version

string

The application version (for example, git commit hash) where the issue was last observed.

platform

enum

Platform associated with the issue. Allowed enum values: ANDROID,BACKEND,BROWSER,FLUTTER,IOS,REACT_NATIVE,ROKU,UNKNOWN

service

string

Service name.

state

enum

State of the issue Allowed enum values: OPEN,ACKNOWLEDGED,RESOLVED,IGNORED,EXCLUDED

id [required]

string

Issue identifier.

relationships

object

Relationship between the issue and an assignee, case and/or teams.

assignee

object

Relationship between the issue and assignee.

data [required]

object

The user the issue is assigned to.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

case

object

Relationship between the issue and case.

data [required]

object

The case the issue is attached to.

id [required]

string

Case identifier.

type [required]

enum

Type of the object. Allowed enum values: case

team_owners

object

Relationship between the issue and teams.

data [required]

[object]

Array of teams that are owners of the issue.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

type [required]

enum

Type of the object. Allowed enum values: issue

included

[ <oneOf>]

Array of resources related to the issue.

Option 1

object

The case attached to the issue.

attributes [required]

object

Object containing the information of a case.

archived_at

date-time

Timestamp of when the case was archived.

closed_at

date-time

Timestamp of when the case was closed.

created_at

date-time

Timestamp of when the case was created.

creation_source

string

Source of the case creation.

description

string

Description of the case.

due_date

string

Due date of the case.

insights

[object]

Insights of the case.

ref

string

Reference of the insight.

resource_id

string

Insight identifier.

type

string

Type of the insight.

jira_issue

object

Jira issue of the case.

result

object

Contains the identifiers and URL for a successfully created Jira issue.

issue_id

string

Jira issue identifier.

issue_key

string

Jira issue key.

issue_url

string

Jira issue URL.

project_key

string

Jira project key.

status

string

Creation status of the Jira issue.

key

string

Key of the case.

modified_at

date-time

Timestamp of when the case was last modified.

priority

enum

Case priority Allowed enum values: NOT_DEFINED,P1,P2,P3,P4,P5

default: NOT_DEFINED

status

enum

Case status Allowed enum values: OPEN,IN_PROGRESS,CLOSED

title

string

Title of the case.

type

string

Type of the case.

id [required]

string

Case identifier.

relationships

object

Resources related to a case.

assignee

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

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

Type of the object. Allowed enum values: case

Option 2

object

The user to whom the issue is assigned.

attributes [required]

object

Object containing the information of a user.

email

string

Email of the user.

handle

string

Handle of the user.

name

string

Name of the user.

id [required]

string

User identifier.

type [required]

enum

Type of the object Allowed enum values: user

Option 3

object

A team that owns an issue.

attributes [required]

object

Object containing the information of a team.

handle

string

The team's identifier.

name

string

The name of the team.

summary

string

A brief summary of the team, derived from its description.

id [required]

string

Team identifier.

type [required]

enum

Type of the object. Allowed enum values: team

{
  "data": {
    "attributes": {
      "error_message": "object of type 'NoneType' has no len()",
      "error_type": "builtins.TypeError",
      "file_path": "/django-email/conduit/apps/core/utils.py",
      "first_seen": 1671612804001,
      "first_seen_version": "aaf65cd0",
      "function_name": "filter_forbidden_tags",
      "is_crash": false,
      "languages": [
        "PYTHON",
        "GO"
      ],
      "last_seen": 1671620003100,
      "last_seen_version": "b6199f80",
      "platform": "BACKEND",
      "service": "email-api-py",
      "state": "RESOLVED"
    },
    "id": "c1726a66-1f64-11ee-b338-da7ad0900002",
    "relationships": {
      "assignee": {
        "data": {
          "id": "87cb11a0-278c-440a-99fe-701223c80296",
          "type": "user"
        }
      },
      "case": {
        "data": {
          "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
          "type": "case"
        }
      },
      "team_owners": {
        "data": [
          {
            "id": "221b0179-6447-4d03-91c3-3ca98bf60e8a",
            "type": "team"
          }
        ]
      }
    },
    "type": "issue"
  },
  "included": [
    {
      "attributes": {
        "archived_at": "2025-01-01T00:00:00Z",
        "closed_at": "2025-01-01T00:00:00Z",
        "created_at": "2025-01-01T00:00:00Z",
        "creation_source": "ERROR_TRACKING",
        "description": "string",
        "due_date": "2025-01-01",
        "insights": [
          {
            "ref": "/error-tracking?issueId=2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "resource_id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
            "type": "ERROR_TRACKING"
          }
        ],
        "jira_issue": {
          "result": {
            "issue_id": "1904866",
            "issue_key": "ET-123",
            "issue_url": "https://your-jira-instance.atlassian.net/browse/ET-123",
            "project_key": "ET"
          },
          "status": "COMPLETED"
        },
        "key": "ET-123",
        "modified_at": "2025-01-01T00:00:00Z",
        "priority": "NOT_DEFINED",
        "status": "OPEN",
        "title": "Error: HTTP error",
        "type": "ERROR_TRACKING_ISSUE"
      },
      "id": "2841440d-e780-4fe2-96cd-6a8c1d194da5",
      "relationships": {
        "assignee": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "user"
          }
        },
        "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": "case"
    }
  ]
}

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 issue_id="c1726a66-1f64-11ee-b338-da7ad0900002"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/error-tracking/issues/${issue_id}/assignee" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "id": "87cb11a0-278c-440a-99fe-701223c80296",
    "type": "assignee"
  }
}
EOF