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. Possible values are issue, issue.assignee, issue.case, and issue.team_owners.
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
regression
object
Regression information for an issue that was previously resolved and then reopened.
regressed_at [required]
date-time
Timestamp when the issue was reopened (regressed).
regressed_at_version
string
Application version where the regression was observed.
resolved_at [required]
date-time
Timestamp when the issue was resolved before the regression.
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
Key-value pairs of case attributes. Each key maps to an array of string values, used for flexible metadata such as labels or tags.
<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
custom_attributes
object
Case custom attributes
<any-key>
object
A typed value for a custom attribute on a specific case.
is_multi [required]
boolean
If true, value must be an array
type [required]
enum
The data type of the custom attribute, which determines the allowed values and UI input control.
Allowed enum values: URL,TEXT,NUMBER,SELECT
value [required]
<oneOf>
The value of a custom attribute. The accepted format depends on the attribute's type and whether it accepts multiple values.
Option 1
string
A string value for a TEXT, URL, or SELECT-type custom attribute.
Option 2
[string]
An array of string values for a multi-value TEXT, URL, or SELECT-type custom attribute.
Option 3
double
A numeric value for a NUMBER-type custom attribute.
Option 4
[number]
An array of numeric values for a multi-value NUMBER-type custom attribute.
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
DEPRECATED: Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use status_name instead.
Allowed enum values: OPEN,IN_PROGRESS,CLOSED
status_group
enum
Status group of the case.
Allowed enum values: SG_OPEN,SG_IN_PROGRESS,SG_CLOSED
status_name
string
Status of the case. Must be one of the existing statuses for the case's type.
title
string
Title
type
enum
DEPRECATED: Case type
Allowed enum values: STANDARD
JSON:API resource type for cases.
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","regression":{"regressed_at":"2024-01-03T08:00:00Z","regressed_at_version":"v2.5.2","resolved_at":"2024-01-01T10:00:00Z"},"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"}]}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Search error tracking issues returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.ErrorTrackingApi(configuration);constparams: v2.ErrorTrackingApiSearchIssuesRequest={body:{data:{attributes:{query:"service:orders-* AND @language:go",from:1671612804000,to: 1671620004000,track:"trace",},type:"search_request",},},};apiInstance.searchIssues(params).then((data: v2.IssuesSearchResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));