data [required]
\nobject
Data object for the annotations response.
attributes [required]
\nobject
Attributes of the annotations response.
annotations [required]
\n[object]
Successfully created or updated annotations.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\n[object]
Label values for this annotation. Each entry references a label schema by ID\nand provides the corresponding value.
assessment
\nenum
Assessment result for a label value. \nAllowed enum values: pass,fail
label_schema_id [required]
\nstring
ID of the label schema this value corresponds to.
name_when_saved
\nstring
Name of the label schema at the time the annotation was created.
reasoning
\nstring
Free text reasoning for this label value.
type
\nenum
Type of a label in an annotation queue label schema. \nAllowed enum values: score,categorical,boolean,text
value [required]
\n<oneOf>
The value for this label. Must comply with the label schema type constraints.
Object 1
\ndouble
A scalar numeric value.
Object 2
\nstring
A scalar string value.
Object 3
\n[string]
For categorical-type labels allowing multiple selections.
Object 4
\nboolean
A scalar boolean value.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
errors
\n[object]
Partial errors for annotations that could not be processed.
annotation_id
\nstring
ID of the annotation that failed, if applicable.
error [required]
\nstring
Error message.
interaction_id [required]
\nstring
ID of the interaction that failed.
id [required]
\nstring
The annotation queue ID.
type [required]
\nenum
Resource type for Agent Observability annotations. \nAllowed enum values: annotations
data [required]
\nobject
Data object for the annotations response.
attributes [required]
\nobject
Attributes of the annotations response.
annotations [required]
\n[object]
Successfully created or updated annotations.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\n[object]
Label values for this annotation. Each entry references a label schema by ID\nand provides the corresponding value.
assessment
\nenum
Assessment result for a label value. \nAllowed enum values: pass,fail
label_schema_id [required]
\nstring
ID of the label schema this value corresponds to.
name_when_saved
\nstring
Name of the label schema at the time the annotation was created.
reasoning
\nstring
Free text reasoning for this label value.
type
\nenum
Type of a label in an annotation queue label schema. \nAllowed enum values: score,categorical,boolean,text
value [required]
\n<oneOf>
The value for this label. Must comply with the label schema type constraints.
Object 1
\ndouble
A scalar numeric value.
Object 2
\nstring
A scalar value represented as a string.
Object 3
\n[string]
For categorical-type labels allowing multiple selections.
Object 4
\nboolean
A scalar boolean value.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
errors
\n[object]
Partial errors for annotations that could not be processed.
annotation_id
\nstring
ID of the annotation that failed, if applicable.
error [required]
\nstring
Error message.
interaction_id [required]
\nstring
ID of the interaction that failed.
id [required]
\nstring
The annotation queue ID.
type [required]
\nenum
Resource type for Agent Observability annotations. \nAllowed enum values: annotations
data [required]
\nobject
Data object for creating or updating annotations.
attributes [required]
\nobject
Attributes for creating or updating annotations.
annotations [required]
\n[object]
List of annotations to create or update. Must contain at least one item.
interaction_id [required]
\nstring
ID of the interaction to annotate.
label_values [required]
\n[object]
Label values for this annotation. Each entry references a label schema by ID\nand provides the corresponding value validated against the schema type constraints.
assessment
\nenum
Assessment result for a label value. \nAllowed enum values: pass,fail
label_schema_id [required]
\nstring
ID of the label schema this value corresponds to.
reasoning
\nstring
Free text reasoning for this label value.
value [required]
\n<oneOf>
The value for this label. Must comply with the label schema type constraints.
Object 1
\ndouble
A scalar numeric value.
Object 2
\nstring
A scalar string value.
Object 3
\n[string]
For categorical-type labels allowing multiple selections.
Object 4
\nboolean
A scalar boolean value.
type [required]
\nenum
Resource type for Agent Observability annotations. \nAllowed enum values: annotations
data [required]
\nobject
Data object for creating or updating annotations.
attributes [required]
\nobject
Attributes for creating or updating annotations.
annotations [required]
\n[object]
List of annotations to create or update. Must contain at least one item.
interaction_id [required]
\nstring
ID of the interaction to annotate.
label_values [required]
\n[object]
Label values for this annotation. Each entry references a label schema by ID\nand provides the corresponding value validated against the schema type constraints.
assessment
\nenum
Assessment result for a label value. \nAllowed enum values: pass,fail
label_schema_id [required]
\nstring
ID of the label schema this value corresponds to.
reasoning
\nstring
Free text reasoning for this label value.
value [required]
\n<oneOf>
The value for this label. Must comply with the label schema type constraints.
Object 1
\ndouble
A scalar numeric value.
Object 2
\nstring
A scalar value represented as a string.
Object 3
\n[string]
For categorical-type labels allowing multiple selections.
Object 4
\nboolean
A scalar boolean value.
type [required]
\nenum
Resource type for Agent Observability annotations. \nAllowed enum values: annotations
data [required]
\nobject
JSON:API data object for an experimentation search response.
attributes [required]
\nobject
The matching experimentation entities grouped by type.
dataset_records
\n[object]
Matching dataset records. Present when dataset_records is included in filter.scope.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
datasets
\n[object]
Matching datasets. Present when datasets is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability dataset.
created_at [required]
\ndate-time
Timestamp when the dataset was created.
current_version [required]
\nint64
Current version number of the dataset.
description [required]
\nstring
Description of the dataset.
metadata [required]
\nobject
Arbitrary metadata associated with the dataset.
name [required]
\nstring
Name of the dataset.
updated_at [required]
\ndate-time
Timestamp when the dataset was last updated.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
experiment_runs
\n[object]
Matching experiment runs. Present when experiment_runs is included in filter.scope.
aggregate_data
\nobject
Aggregated metric data for this run.
created_at
\ndate-time
Timestamp when the run was created.
experiment_id
\nstring
Identifier of the experiment this run belongs to.
id
\nstring
Unique identifier of the experiment run.
run_number
\nint32
Sequential number of this run within the experiment.
experiments
\n[object]
Matching experiments. Present when experiments is included in filter.scope.
aggregate_data
\nobject
Pre-computed aggregate metrics for this experiment run, including eval score distributions, token costs, and error rates.
author
\nobject
User data for the author of an experiment. Only present when include[user_data] is true.
string
Email address of the user.
handle
\nstring
Username or handle associated with the user's Datadog account.
icon
\nstring
URL of the user's icon.
id
\nstring
Unique identifier of the user.
name
\nstring
Display name of the user.
config [required]
\nobject
Configuration parameters for the experiment.
created_at [required]
\ndate-time
Timestamp when the experiment was created.
dataset_id [required]
\nstring
Identifier of the dataset used in this experiment.
dataset_name
\nstring
Name of the dataset used in this experiment.\nOnly present when include[dataset_names] is true.
dataset_version
\nint64
Version of the dataset used in this experiment.
deleted_at
\ndate-time
Timestamp when the experiment was soft-deleted, if applicable.
description [required]
\nstring
Description of the experiment.
error
\nstring
Error message describing why the experiment failed, if applicable.
experiment
\nstring
Logical name of the experiment, shared across all runs of the same pipeline.
metadata [required]
\nobject
Arbitrary metadata associated with the experiment.
name [required]
\nstring
Name of the experiment.
parent_experiment_id
\nstring
Identifier of the parent (baseline) experiment this experiment was run against, if any.
project_id [required]
\nstring
Identifier of the project this experiment belongs to.
run_count
\nint32
Expected number of runs for this experiment.
status
\nenum
Execution status of an Agent Observability experiment. \nAllowed enum values: running,completed,failed,interrupted
updated_at [required]
\ndate-time
Timestamp when the experiment was last updated.
projects
\n[object]
Matching projects. Present when projects is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability project.
created_at [required]
\ndate-time
Timestamp when the project was created.
description [required]
\nstring
Description of the project.
name [required]
\nstring
Name of the project.
updated_at [required]
\ndate-time
Timestamp when the project was last updated.
id [required]
\nstring
Unique identifier of the project.
type [required]
\nenum
Resource type of an Agent Observability project. \nAllowed enum values: projects
id [required]
\nstring
Server-generated identifier for this search result.
type [required]
\nenum
Resource type for experimentation search and analytics operations. \nAllowed enum values: experimentation
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for an experimentation search response.
attributes [required]
\nobject
The matching experimentation entities grouped by type.
dataset_records
\n[object]
Matching dataset records. Present when dataset_records is included in filter.scope.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
datasets
\n[object]
Matching datasets. Present when datasets is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability dataset.
created_at [required]
\ndate-time
Timestamp when the dataset was created.
current_version [required]
\nint64
Current version number of the dataset.
description [required]
\nstring
Description of the dataset.
metadata [required]
\nobject
Arbitrary metadata associated with the dataset.
name [required]
\nstring
Name of the dataset.
updated_at [required]
\ndate-time
Timestamp when the dataset was last updated.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
experiment_runs
\n[object]
Matching experiment runs. Present when experiment_runs is included in filter.scope.
aggregate_data
\nobject
Aggregated metric data for this run.
created_at
\ndate-time
Timestamp when the run was created.
experiment_id
\nstring
Identifier of the experiment this run belongs to.
id
\nstring
Unique identifier of the experiment run.
run_number
\nint32
Sequential number of this run within the experiment.
experiments
\n[object]
Matching experiments. Present when experiments is included in filter.scope.
aggregate_data
\nobject
Pre-computed aggregate metrics for this experiment run, including eval score distributions, token costs, and error rates.
author
\nobject
User data for the author of an experiment. Only present when include[user_data] is true.
string
Email address of the user.
handle
\nstring
Username or handle associated with the user's Datadog account.
icon
\nstring
URL of the user's icon.
id
\nstring
Unique identifier of the user.
name
\nstring
Display name of the user.
config [required]
\nobject
Configuration parameters for the experiment.
created_at [required]
\ndate-time
Timestamp when the experiment was created.
dataset_id [required]
\nstring
Identifier of the dataset used in this experiment.
dataset_name
\nstring
Name of the dataset used in this experiment.\nOnly present when include[dataset_names] is true.
dataset_version
\nint64
Version of the dataset used in this experiment.
deleted_at
\ndate-time
Timestamp when the experiment was soft-deleted, if applicable.
description [required]
\nstring
Description of the experiment.
error
\nstring
Error message describing why the experiment failed, if applicable.
experiment
\nstring
Logical name of the experiment, shared across all runs of the same pipeline.
metadata [required]
\nobject
Arbitrary metadata associated with the experiment.
name [required]
\nstring
Name of the experiment.
parent_experiment_id
\nstring
Identifier of the parent (baseline) experiment this experiment was run against, if any.
project_id [required]
\nstring
Identifier of the project this experiment belongs to.
run_count
\nint32
Expected number of runs for this experiment.
status
\nenum
Execution status of an Agent Observability experiment. \nAllowed enum values: running,completed,failed,interrupted
updated_at [required]
\ndate-time
Timestamp when the experiment was last updated.
projects
\n[object]
Matching projects. Present when projects is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability project.
created_at [required]
\ndate-time
Timestamp when the project was created.
description [required]
\nstring
Description of the project.
name [required]
\nstring
Name of the project.
updated_at [required]
\ndate-time
Timestamp when the project was last updated.
id [required]
\nstring
Unique identifier of the project.
type [required]
\nenum
Resource type of an Agent Observability project. \nAllowed enum values: projects
id [required]
\nstring
Server-generated identifier for this search result.
type [required]
\nenum
Resource type for experimentation search and analytics operations. \nAllowed enum values: experimentation
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for an experimentation search response.
attributes [required]
\nobject
The matching experimentation entities grouped by type.
dataset_records
\n[object]
Matching dataset records. Present when dataset_records is included in filter.scope.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
datasets
\n[object]
Matching datasets. Present when datasets is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability dataset.
created_at [required]
\ndate-time
Timestamp when the dataset was created.
current_version [required]
\nint64
Current version number of the dataset.
description [required]
\nstring
Description of the dataset.
metadata [required]
\nobject
Arbitrary metadata associated with the dataset.
name [required]
\nstring
Name of the dataset.
updated_at [required]
\ndate-time
Timestamp when the dataset was last updated.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
experiment_runs
\n[object]
Matching experiment runs. Present when experiment_runs is included in filter.scope.
aggregate_data
\nobject
Aggregated metric data for this run.
created_at
\ndate-time
Timestamp when the run was created.
experiment_id
\nstring
Identifier of the experiment this run belongs to.
id
\nstring
Unique identifier of the experiment run.
run_number
\nint32
Sequential number of this run within the experiment.
experiments
\n[object]
Matching experiments. Present when experiments is included in filter.scope.
aggregate_data
\nobject
Pre-computed aggregate metrics for this experiment run, including eval score distributions, token costs, and error rates.
author
\nobject
User data for the author of an experiment. Only present when include[user_data] is true.
string
Email address of the user.
handle
\nstring
Username or handle associated with the user's Datadog account.
icon
\nstring
URL of the user's icon.
id
\nstring
Unique identifier of the user.
name
\nstring
Display name of the user.
config [required]
\nobject
Configuration parameters for the experiment.
created_at [required]
\ndate-time
Timestamp when the experiment was created.
dataset_id [required]
\nstring
Identifier of the dataset used in this experiment.
dataset_name
\nstring
Name of the dataset used in this experiment.\nOnly present when include[dataset_names] is true.
dataset_version
\nint64
Version of the dataset used in this experiment.
deleted_at
\ndate-time
Timestamp when the experiment was soft-deleted, if applicable.
description [required]
\nstring
Description of the experiment.
error
\nstring
Error message describing why the experiment failed, if applicable.
experiment
\nstring
Logical name of the experiment, shared across all runs of the same pipeline.
metadata [required]
\nobject
Arbitrary metadata associated with the experiment.
name [required]
\nstring
Name of the experiment.
parent_experiment_id
\nstring
Identifier of the parent (baseline) experiment this experiment was run against, if any.
project_id [required]
\nstring
Identifier of the project this experiment belongs to.
run_count
\nint32
Expected number of runs for this experiment.
status
\nenum
Execution status of an Agent Observability experiment. \nAllowed enum values: running,completed,failed,interrupted
updated_at [required]
\ndate-time
Timestamp when the experiment was last updated.
projects
\n[object]
Matching projects. Present when projects is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability project.
created_at [required]
\ndate-time
Timestamp when the project was created.
description [required]
\nstring
Description of the project.
name [required]
\nstring
Name of the project.
updated_at [required]
\ndate-time
Timestamp when the project was last updated.
id [required]
\nstring
Unique identifier of the project.
type [required]
\nenum
Resource type of an Agent Observability project. \nAllowed enum values: projects
id [required]
\nstring
Server-generated identifier for this search result.
type [required]
\nenum
Resource type for experimentation search and analytics operations. \nAllowed enum values: experimentation
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for an experimentation search response.
attributes [required]
\nobject
The matching experimentation entities grouped by type.
dataset_records
\n[object]
Matching dataset records. Present when dataset_records is included in filter.scope.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
datasets
\n[object]
Matching datasets. Present when datasets is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability dataset.
created_at [required]
\ndate-time
Timestamp when the dataset was created.
current_version [required]
\nint64
Current version number of the dataset.
description [required]
\nstring
Description of the dataset.
metadata [required]
\nobject
Arbitrary metadata associated with the dataset.
name [required]
\nstring
Name of the dataset.
updated_at [required]
\ndate-time
Timestamp when the dataset was last updated.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
experiment_runs
\n[object]
Matching experiment runs. Present when experiment_runs is included in filter.scope.
aggregate_data
\nobject
Aggregated metric data for this run.
created_at
\ndate-time
Timestamp when the run was created.
experiment_id
\nstring
Identifier of the experiment this run belongs to.
id
\nstring
Unique identifier of the experiment run.
run_number
\nint32
Sequential number of this run within the experiment.
experiments
\n[object]
Matching experiments. Present when experiments is included in filter.scope.
aggregate_data
\nobject
Pre-computed aggregate metrics for this experiment run, including eval score distributions, token costs, and error rates.
author
\nobject
User data for the author of an experiment. Only present when include[user_data] is true.
string
Email address of the user.
handle
\nstring
Username or handle associated with the user's Datadog account.
icon
\nstring
URL of the user's icon.
id
\nstring
Unique identifier of the user.
name
\nstring
Display name of the user.
config [required]
\nobject
Configuration parameters for the experiment.
created_at [required]
\ndate-time
Timestamp when the experiment was created.
dataset_id [required]
\nstring
Identifier of the dataset used in this experiment.
dataset_name
\nstring
Name of the dataset used in this experiment.\nOnly present when include[dataset_names] is true.
dataset_version
\nint64
Version of the dataset used in this experiment.
deleted_at
\ndate-time
Timestamp when the experiment was soft-deleted, if applicable.
description [required]
\nstring
Description of the experiment.
error
\nstring
Error message describing why the experiment failed, if applicable.
experiment
\nstring
Logical name of the experiment, shared across all runs of the same pipeline.
metadata [required]
\nobject
Arbitrary metadata associated with the experiment.
name [required]
\nstring
Name of the experiment.
parent_experiment_id
\nstring
Identifier of the parent (baseline) experiment this experiment was run against, if any.
project_id [required]
\nstring
Identifier of the project this experiment belongs to.
run_count
\nint32
Expected number of runs for this experiment.
status
\nenum
Execution status of an Agent Observability experiment. \nAllowed enum values: running,completed,failed,interrupted
updated_at [required]
\ndate-time
Timestamp when the experiment was last updated.
projects
\n[object]
Matching projects. Present when projects is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability project.
created_at [required]
\ndate-time
Timestamp when the project was created.
description [required]
\nstring
Description of the project.
name [required]
\nstring
Name of the project.
updated_at [required]
\ndate-time
Timestamp when the project was last updated.
id [required]
\nstring
Unique identifier of the project.
type [required]
\nenum
Resource type of an Agent Observability project. \nAllowed enum values: projects
id [required]
\nstring
Server-generated identifier for this search result.
type [required]
\nenum
Resource type for experimentation search and analytics operations. \nAllowed enum values: experimentation
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for a simple search response.
attributes [required]
\nobject
The matching experimentation entities grouped by type.
dataset_records
\n[object]
Matching dataset records. Present when dataset_records is included in filter.scope.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
datasets
\n[object]
Matching datasets. Present when datasets is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability dataset.
created_at [required]
\ndate-time
Timestamp when the dataset was created.
current_version [required]
\nint64
Current version number of the dataset.
description [required]
\nstring
Description of the dataset.
metadata [required]
\nobject
Arbitrary metadata associated with the dataset.
name [required]
\nstring
Name of the dataset.
updated_at [required]
\ndate-time
Timestamp when the dataset was last updated.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
experiment_runs
\n[object]
Matching experiment runs. Present when experiment_runs is included in filter.scope.
aggregate_data
\nobject
Aggregated metric data for this run.
created_at
\ndate-time
Timestamp when the run was created.
experiment_id
\nstring
Identifier of the experiment this run belongs to.
id
\nstring
Unique identifier of the experiment run.
run_number
\nint32
Sequential number of this run within the experiment.
experiments
\n[object]
Matching experiments. Present when experiments is included in filter.scope.
aggregate_data
\nobject
Pre-computed aggregate metrics for this experiment run, including eval score distributions, token costs, and error rates.
author
\nobject
User data for the author of an experiment. Only present when include[user_data] is true.
string
Email address of the user.
handle
\nstring
Username or handle associated with the user's Datadog account.
icon
\nstring
URL of the user's icon.
id
\nstring
Unique identifier of the user.
name
\nstring
Display name of the user.
config [required]
\nobject
Configuration parameters for the experiment.
created_at [required]
\ndate-time
Timestamp when the experiment was created.
dataset_id [required]
\nstring
Identifier of the dataset used in this experiment.
dataset_name
\nstring
Name of the dataset used in this experiment.\nOnly present when include[dataset_names] is true.
dataset_version
\nint64
Version of the dataset used in this experiment.
deleted_at
\ndate-time
Timestamp when the experiment was soft-deleted, if applicable.
description [required]
\nstring
Description of the experiment.
error
\nstring
Error message describing why the experiment failed, if applicable.
experiment
\nstring
Logical name of the experiment, shared across all runs of the same pipeline.
metadata [required]
\nobject
Arbitrary metadata associated with the experiment.
name [required]
\nstring
Name of the experiment.
parent_experiment_id
\nstring
Identifier of the parent (baseline) experiment this experiment was run against, if any.
project_id [required]
\nstring
Identifier of the project this experiment belongs to.
run_count
\nint32
Expected number of runs for this experiment.
status
\nenum
Execution status of an Agent Observability experiment. \nAllowed enum values: running,completed,failed,interrupted
updated_at [required]
\ndate-time
Timestamp when the experiment was last updated.
projects
\n[object]
Matching projects. Present when projects is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability project.
created_at [required]
\ndate-time
Timestamp when the project was created.
description [required]
\nstring
Description of the project.
name [required]
\nstring
Name of the project.
updated_at [required]
\ndate-time
Timestamp when the project was last updated.
id [required]
\nstring
Unique identifier of the project.
type [required]
\nenum
Resource type of an Agent Observability project. \nAllowed enum values: projects
id [required]
\nstring
Server-generated identifier for this search result.
type [required]
\nenum
Resource type for experimentation search and analytics operations. \nAllowed enum values: experimentation
meta
\nobject
Pagination metadata for a simple search response.
page
\nobject
Page metadata.
current
\nint32
Current page number.
limit
\nint32
Page size used for this response.
total_count
\nint32
Total number of matching results (capped at the maximum search limit).
total_pages
\nint32
Total number of pages available.
data [required]
\nobject
JSON:API data object for a simple search response.
attributes [required]
\nobject
The matching experimentation entities grouped by type.
dataset_records
\n[object]
Matching dataset records. Present when dataset_records is included in filter.scope.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
datasets
\n[object]
Matching datasets. Present when datasets is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability dataset.
created_at [required]
\ndate-time
Timestamp when the dataset was created.
current_version [required]
\nint64
Current version number of the dataset.
description [required]
\nstring
Description of the dataset.
metadata [required]
\nobject
Arbitrary metadata associated with the dataset.
name [required]
\nstring
Name of the dataset.
updated_at [required]
\ndate-time
Timestamp when the dataset was last updated.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
experiment_runs
\n[object]
Matching experiment runs. Present when experiment_runs is included in filter.scope.
aggregate_data
\nobject
Aggregated metric data for this run.
created_at
\ndate-time
Timestamp when the run was created.
experiment_id
\nstring
Identifier of the experiment this run belongs to.
id
\nstring
Unique identifier of the experiment run.
run_number
\nint32
Sequential number of this run within the experiment.
experiments
\n[object]
Matching experiments. Present when experiments is included in filter.scope.
aggregate_data
\nobject
Pre-computed aggregate metrics for this experiment run, including eval score distributions, token costs, and error rates.
author
\nobject
User data for the author of an experiment. Only present when include[user_data] is true.
string
Email address of the user.
handle
\nstring
Username or handle associated with the user's Datadog account.
icon
\nstring
URL of the user's icon.
id
\nstring
Unique identifier of the user.
name
\nstring
Display name of the user.
config [required]
\nobject
Configuration parameters for the experiment.
created_at [required]
\ndate-time
Timestamp when the experiment was created.
dataset_id [required]
\nstring
Identifier of the dataset used in this experiment.
dataset_name
\nstring
Name of the dataset used in this experiment.\nOnly present when include[dataset_names] is true.
dataset_version
\nint64
Version of the dataset used in this experiment.
deleted_at
\ndate-time
Timestamp when the experiment was soft-deleted, if applicable.
description [required]
\nstring
Description of the experiment.
error
\nstring
Error message describing why the experiment failed, if applicable.
experiment
\nstring
Logical name of the experiment, shared across all runs of the same pipeline.
metadata [required]
\nobject
Arbitrary metadata associated with the experiment.
name [required]
\nstring
Name of the experiment.
parent_experiment_id
\nstring
Identifier of the parent (baseline) experiment this experiment was run against, if any.
project_id [required]
\nstring
Identifier of the project this experiment belongs to.
run_count
\nint32
Expected number of runs for this experiment.
status
\nenum
Execution status of an Agent Observability experiment. \nAllowed enum values: running,completed,failed,interrupted
updated_at [required]
\ndate-time
Timestamp when the experiment was last updated.
projects
\n[object]
Matching projects. Present when projects is included in filter.scope.
attributes [required]
\nobject
Attributes of an Agent Observability project.
created_at [required]
\ndate-time
Timestamp when the project was created.
description [required]
\nstring
Description of the project.
name [required]
\nstring
Name of the project.
updated_at [required]
\ndate-time
Timestamp when the project was last updated.
id [required]
\nstring
Unique identifier of the project.
type [required]
\nenum
Resource type of an Agent Observability project. \nAllowed enum values: projects
id [required]
\nstring
Server-generated identifier for this search result.
type [required]
\nenum
Resource type for experimentation search and analytics operations. \nAllowed enum values: experimentation
meta
\nobject
Pagination metadata for a simple search response.
page
\nobject
Page metadata.
current
\nint32
Current page number.
limit
\nint32
Page size used for this response.
total_count
\nint32
Total number of matching results (capped at the maximum search limit).
total_pages
\nint32
Total number of pages available.
data [required]
\n[object]
List of experiment spans with their evaluation metrics.
attributes [required]
\nobject
An experiment span enriched with its associated evaluation metrics.
dataset_record_id
\nstring
ID of the dataset record this span evaluated.
duration
\ndouble
Duration of the span in nanoseconds.
eval_metrics
\n[object]
Evaluation metrics associated with this span.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id
\nstring
Unique identifier of the span.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metrics
\nobject
Numeric metrics attached to the span.
<any-key>
\ndouble
name
\nstring
Name of the span.
parent_id
\nstring
Parent span ID, if any.
span_id
\nstring
Span ID.
start_ns
\nint64
Start time in nanoseconds since Unix epoch.
status
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
Tags associated with the span.
trace_id
\nstring
Trace ID.
id [required]
\nstring
Unique identifier of the span.
type [required]
\nenum
Resource type for a span item in an experiment spans response. \nAllowed enum values: experiments
data [required]
\n[object]
List of experiment spans with their evaluation metrics.
attributes [required]
\nobject
An experiment span enriched with its associated evaluation metrics.
dataset_record_id
\nstring
ID of the dataset record this span evaluated.
duration
\ndouble
Duration of the span in nanoseconds.
eval_metrics
\n[object]
Evaluation metrics associated with this span.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id
\nstring
Unique identifier of the span.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metrics
\nobject
Numeric metrics attached to the span.
<any-key>
\ndouble
name
\nstring
Name of the span.
parent_id
\nstring
Parent span ID, if any.
span_id
\nstring
Span ID.
start_ns
\nint64
Start time in nanoseconds since Unix epoch.
status
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
Tags associated with the span.
trace_id
\nstring
Trace ID.
id [required]
\nstring
Unique identifier of the span.
type [required]
\nenum
Resource type for a span item in an experiment spans response. \nAllowed enum values: experiments
data [required]
\nobject
Data object for pushing experiment events.
attributes [required]
\nobject
Attributes for pushing experiment events including spans and metrics.
metrics
\n[object]
List of metrics to push for the experiment.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Used when metric_type is boolean.
categorical_value
\nstring
Categorical value. Used when metric_type is categorical.
error
\nobject
Error details for an experiment metric evaluation.
message
\nstring
Error message associated with the metric evaluation.
json_value
\nobject
JSON value. Used when metric_type is json.
label [required]
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_type [required]
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score value. Used when metric_type is score.
span_id [required]
\nstring
The ID of the span this metric measures.
tags
\n[string]
List of tags associated with the metric.
timestamp_ms [required]
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
spans
\n[object]
List of spans to push for the experiment.
dataset_id [required]
\nstring
Dataset ID associated with this span.
duration [required]
\nint64
Duration of the span in nanoseconds.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
name [required]
\nstring
Name of the span.
project_id [required]
\nstring
Project ID associated with this span.
span_id [required]
\nstring
Unique identifier of the span.
start_ns [required]
\nint64
Start time of the span in nanoseconds since Unix epoch.
status [required]
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
List of tags associated with the span.
trace_id [required]
\nstring
Trace ID for the span.
type [required]
\nenum
Resource type for Agent Observability experiment events. \nAllowed enum values: events
data [required]
\nobject
Data object for pushing experiment events.
attributes [required]
\nobject
Attributes for pushing experiment events including spans and metrics.
metrics
\n[object]
List of metrics to push for the experiment.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Used when metric_type is boolean.
categorical_value
\nstring
Categorical value. Used when metric_type is categorical.
error
\nobject
Error details for an experiment metric evaluation.
message
\nstring
Error message associated with the metric evaluation.
json_value
\nobject
JSON value. Used when metric_type is json.
label [required]
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_type [required]
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score value. Used when metric_type is score.
span_id [required]
\nstring
The ID of the span this metric measures.
tags
\n[string]
List of tags associated with the metric.
timestamp_ms [required]
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
spans
\n[object]
List of spans to push for the experiment.
dataset_id [required]
\nstring
Dataset ID associated with this span.
duration [required]
\nint64
Duration of the span in nanoseconds.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
name [required]
\nstring
Name of the span.
project_id [required]
\nstring
Project ID associated with this span.
span_id [required]
\nstring
Unique identifier of the span.
start_ns [required]
\nint64
Start time of the span in nanoseconds since Unix epoch.
status [required]
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
List of tags associated with the span.
trace_id [required]
\nstring
Trace ID for the span.
type [required]
\nenum
Resource type for Agent Observability experiment events. \nAllowed enum values: events
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\nobject
Data object for batch-updating records in an Agent Observability dataset.
attributes [required]
\nobject
Attributes for batch-updating records in an Agent Observability dataset.
create_new_version
\nboolean
Whether to create a new dataset version when applying the batch update. Defaults to true.
delete_records
\n[string]
Record IDs to delete.
insert_records
\n[object]
Records to insert.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id
\nstring
Optional user-provided identifier for the record. If omitted, the server generates an identifier.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Arbitrary metadata associated with the record.
tag_operations
\nobject
Explicit tag operations for updating records. Operations are applied in order, Remove then Add then Set. set is the final override; if specified, the result of remove and add is discarded.
add
\n[string]
List of tag strings.
remove
\n[string]
List of tag strings.
set
\n[string]
List of tag strings.
tags
\n[string]
List of tag strings.
tags
\n[string]
List of tag strings.
update_records
\n[object]
Records to update by ID.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record to update.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Updated metadata associated with the record.
tag_operations
\nobject
Explicit tag operations for updating records. Operations are applied in order, Remove then Add then Set. set is the final override; if specified, the result of remove and add is discarded.
add
\n[string]
List of tag strings.
remove
\n[string]
List of tag strings.
set
\n[string]
List of tag strings.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
data [required]
\nobject
Data object for batch-updating records in an Agent Observability dataset.
attributes [required]
\nobject
Attributes for batch-updating records in an Agent Observability dataset.
create_new_version
\nboolean
Whether to create a new dataset version when applying the batch update. Defaults to true.
delete_records
\n[string]
Record IDs to delete.
insert_records
\n[object]
Records to insert.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id
\nstring
Optional user-provided identifier for the record. If omitted, the server generates an identifier.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Arbitrary metadata associated with the record.
tag_operations
\nobject
Explicit tag operations for updating records. Operations are applied in order, Remove then Add then Set. set is the final override; if specified, the result of remove and add is discarded.
add
\n[string]
List of tag strings.
remove
\n[string]
List of tag strings.
set
\n[string]
List of tag strings.
tags
\n[string]
List of tag strings.
tags
\n[string]
List of tag strings.
update_records
\n[object]
Records to update by ID.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record to update.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Updated metadata associated with the record.
tag_operations
\nobject
Explicit tag operations for updating records. Operations are applied in order, Remove then Add then Set. set is the final override; if specified, the result of remove and add is discarded.
add
\n[string]
List of tag strings.
remove
\n[string]
List of tag strings.
set
\n[string]
List of tag strings.
id [required]
\nstring
Unique identifier of the dataset.
type [required]
\nenum
Resource type of an Agent Observability dataset. \nAllowed enum values: datasets
data [required]
\n[object]
List of dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\n[object]
List of dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\nobject
Data object for updating records in an Agent Observability dataset.
attributes [required]
\nobject
Attributes for updating records in an Agent Observability dataset.
records [required]
\n[object]
List of records to update.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record to update.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Updated metadata associated with the record.
type [required]
\nenum
Resource type of Agent Observability dataset records. \nAllowed enum values: records
data [required]
\nobject
Data object for updating records in an Agent Observability dataset.
attributes [required]
\nobject
Attributes for updating records in an Agent Observability dataset.
records [required]
\n[object]
List of records to update.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record to update.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Updated metadata associated with the record.
type [required]
\nenum
Resource type of Agent Observability dataset records. \nAllowed enum values: records
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\n[object]
List of affected dataset records.
records [required]
\n[object]
List of affected dataset records.
created_at [required]
\ndate-time
Timestamp when the record was created.
dataset_id [required]
\nstring
Identifier of the dataset this record belongs to.
expected_output [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
id [required]
\nstring
Unique identifier of the record.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata [required]
\nobject
Arbitrary metadata associated with the record.
updated_at [required]
\ndate-time
Timestamp when the record was last updated.
data [required]
\nobject
Data object for appending records to an Agent Observability dataset.
attributes [required]
\nobject
Attributes for appending records to an Agent Observability dataset.
deduplicate
\nboolean
Whether to deduplicate records before appending. Defaults to true.
records [required]
\n[object]
List of records to append to the dataset.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Arbitrary metadata associated with the record.
type [required]
\nenum
Resource type of Agent Observability dataset records. \nAllowed enum values: records
data [required]
\nobject
Data object for appending records to an Agent Observability dataset.
attributes [required]
\nobject
Attributes for appending records to an Agent Observability dataset.
deduplicate
\nboolean
Whether to deduplicate records before appending. Defaults to true.
records [required]
\n[object]
List of records to append to the dataset.
expected_output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
input [required]
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metadata
\nobject
Arbitrary metadata associated with the record.
type [required]
\nenum
Resource type of Agent Observability dataset records. \nAllowed enum values: records
data [required]
\nobject
JSON:API data object for an experiment events response.
attributes [required]
\nobject
Attributes of an experiment events response.
spans [required]
\n[object]
Experiment spans, each enriched with their associated evaluation metrics.
dataset_record_id
\nstring
ID of the dataset record this span evaluated.
duration
\ndouble
Duration of the span in nanoseconds.
eval_metrics
\n[object]
Evaluation metrics associated with this span.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id
\nstring
Unique identifier of the span.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metrics
\nobject
Numeric metrics attached to the span.
<any-key>
\ndouble
name
\nstring
Name of the span.
parent_id
\nstring
Parent span ID, if any.
span_id
\nstring
Span ID.
start_ns
\nint64
Start time in nanoseconds since Unix epoch.
status
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
Tags associated with the span.
trace_id
\nstring
Trace ID.
summary_metrics [required]
\n[object]
Experiment-level summary evaluation metrics (not tied to individual spans).
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id [required]
\nstring
Identifier for this events resource.
type [required]
\nenum
Resource type for an experiment events collection. \nAllowed enum values: experiment_events
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for an experiment events response.
attributes [required]
\nobject
Attributes of an experiment events response.
spans [required]
\n[object]
Experiment spans, each enriched with their associated evaluation metrics.
dataset_record_id
\nstring
ID of the dataset record this span evaluated.
duration
\ndouble
Duration of the span in nanoseconds.
eval_metrics
\n[object]
Evaluation metrics associated with this span.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id
\nstring
Unique identifier of the span.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metrics
\nobject
Numeric metrics attached to the span.
<any-key>
\ndouble
name
\nstring
Name of the span.
parent_id
\nstring
Parent span ID, if any.
span_id
\nstring
Span ID.
start_ns
\nint64
Start time in nanoseconds since Unix epoch.
status
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
Tags associated with the span.
trace_id
\nstring
Trace ID.
summary_metrics [required]
\n[object]
Experiment-level summary evaluation metrics (not tied to individual spans).
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id [required]
\nstring
Identifier for this events resource.
type [required]
\nenum
Resource type for an experiment events collection. \nAllowed enum values: experiment_events
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for an experiment events response.
attributes [required]
\nobject
Attributes of an experiment events response.
spans [required]
\n[object]
Experiment spans, each enriched with their associated evaluation metrics.
dataset_record_id
\nstring
ID of the dataset record this span evaluated.
duration
\ndouble
Duration of the span in nanoseconds.
eval_metrics
\n[object]
Evaluation metrics associated with this span.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id
\nstring
Unique identifier of the span.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metrics
\nobject
Numeric metrics attached to the span.
<any-key>
\ndouble
name
\nstring
Name of the span.
parent_id
\nstring
Parent span ID, if any.
span_id
\nstring
Span ID.
start_ns
\nint64
Start time in nanoseconds since Unix epoch.
status
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
Tags associated with the span.
trace_id
\nstring
Trace ID.
summary_metrics [required]
\n[object]
Experiment-level summary evaluation metrics (not tied to individual spans).
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id [required]
\nstring
Identifier for this events resource.
type [required]
\nenum
Resource type for an experiment events collection. \nAllowed enum values: experiment_events
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data [required]
\nobject
JSON:API data object for an experiment events response.
attributes [required]
\nobject
Attributes of an experiment events response.
spans [required]
\n[object]
Experiment spans, each enriched with their associated evaluation metrics.
dataset_record_id
\nstring
ID of the dataset record this span evaluated.
duration
\ndouble
Duration of the span in nanoseconds.
eval_metrics
\n[object]
Evaluation metrics associated with this span.
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id
\nstring
Unique identifier of the span.
meta
\nobject
Metadata associated with an experiment span.
error
\nobject
Error details for an experiment span.
message
\nstring
Error message.
stack
\nstring
Stack trace of the error.
type
\nstring
The error type or exception class name.
expected_output
\nobject
Expected output for the span, used for evaluation.
input
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
output
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
metrics
\nobject
Numeric metrics attached to the span.
<any-key>
\ndouble
name
\nstring
Name of the span.
parent_id
\nstring
Parent span ID, if any.
span_id
\nstring
Span ID.
start_ns
\nint64
Start time in nanoseconds since Unix epoch.
status
\nenum
Status of the span. \nAllowed enum values: ok,error
tags
\n[string]
Tags associated with the span.
trace_id
\nstring
Trace ID.
summary_metrics [required]
\n[object]
Experiment-level summary evaluation metrics (not tied to individual spans).
assessment
\nenum
Assessment result for an Agent Observability experiment metric. \nAllowed enum values: pass,fail
boolean_value
\nboolean
Boolean value. Present when metric_type is boolean.
categorical_value
\nstring
Categorical value. Present when metric_type is categorical.
eval_source_type
\nstring
Source type of the evaluation.
id
\nstring
Unique identifier of the evaluation metric event.
json_value
\nobject
JSON value. Present when metric_type is json.
label
\nstring
Label or name for the metric.
metadata
\nobject
Arbitrary metadata associated with the metric.
metric_source
\nstring
Source of the metric. Either custom (user-submitted) or summary (experiment-level aggregate).
metric_type
\nenum
Type of metric recorded for an Agent Observability experiment. \nAllowed enum values: score,categorical,boolean,json
reasoning
\nstring
Human-readable reasoning for the metric value.
score_value
\ndouble
Numeric score. Present when metric_type is score.
span_id
\nstring
Span ID this metric is associated with.
tags
\n[string]
Tags associated with the metric.
timestamp_ms
\nint64
Timestamp when the metric was recorded, in milliseconds since Unix epoch.
trace_id
\nstring
Trace ID linking this metric to a span.
id [required]
\nstring
Identifier for this events resource.
type [required]
\nenum
Resource type for an experiment events collection. \nAllowed enum values: experiment_events
meta
\nobject
Pagination cursor metadata.
after
\nstring
Cursor for the next page of results.
data
\n[object]
Projects response data.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\n[object]
Projects response data.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\nobject
A Project.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\nobject
A Project.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\nobject
A Project.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\nobject
A Project.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\nobject
A Project.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data
\nobject
A Project.
attributes [required]
\nobject
Project attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
key
\nstring
The project's key.
name
\nstring
Project's name.
restricted
\nboolean
Whether the project is restricted.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
id [required]
\nstring
The Project's identifier.
relationships
\nobject
Project relationships.
member_team
\nobject
Relationship between a team and a team link
data
\n[object]
Related team links
id [required]
\nstring
The team link's identifier
type [required]
\nenum
Team link type \nAllowed enum values: team_links
default: team_links
links
\nobject
Links attributes.
related
\nstring
Related link.
member_user
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
User resource type. \nAllowed enum values: user
default: user
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data [required]
\nobject
Project update.
attributes
\nobject
Project update attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
name
\nstring
Project name.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar string value.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
team_uuid
\nstring
Team UUID to associate with the project.
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project
data [required]
\nobject
Project update.
attributes
\nobject
Project update attributes.
columns_config
\nobject
Project columns configuration.
columns
\n[object]
List of column configurations for the project board view.
sort
\nobject
Sort configuration for a project board column.
ascending
\nboolean
Whether to sort in ascending order.
priority
\nint64
The sort priority order for this column.
sort_field
\nstring
The field used to sort items in this column.
type
\nstring
The type of column.
enabled_custom_case_types
\n[string]
List of enabled custom case type IDs.
name
\nstring
Project name.
settings
\nobject
Project settings.
auto_close_inactive_cases
\nobject
Auto-close inactive cases settings.
enabled
\nboolean
Whether auto-close is enabled.
max_inactive_time_in_secs
\nint64
Maximum inactive time in seconds before auto-closing.
auto_transition_assigned_cases
\nobject
Auto-transition assigned cases settings.
auto_transition_assigned_cases_on_self_assigned
\nboolean
Whether to auto-transition cases when self-assigned.
integration_incident
\nobject
Incident integration settings.
auto_escalation_query
\nstring
Query for auto-escalation.
default_incident_commander
\nstring
Default incident commander.
enabled
\nboolean
Whether incident integration is enabled.
field_mappings
\n[object]
List of mappings between incident fields and case fields.
case_field
\nstring
The case field to map the incident field value to.
incident_user_defined_field_id
\nstring
The identifier of the incident user-defined field to map from.
incident_type
\nstring
Incident type.
severity_config
\nobject
Severity configuration for mapping incident priorities to case priorities.
priority_mapping
\nobject
Mapping of incident severity values to case priority values.
<any-key>
\nstring
integration_jira
\nobject
Jira integration settings.
auto_creation
\nobject
Auto-creation settings for Jira issues from cases.
enabled
\nboolean
Whether automatic Jira issue creation is enabled.
enabled
\nboolean
Whether Jira integration is enabled.
metadata
\nobject
Metadata for connecting a case management project to a Jira project.
account_id
\nstring
The Jira account identifier.
issue_type_id
\nstring
The Jira issue type identifier to use when creating issues.
project_id
\nstring
The Jira project identifier to associate with this case project.
sync
\nobject
Synchronization configuration for Jira integration.
enabled
\nboolean
Whether Jira field synchronization is enabled.
properties
\nobject
Field synchronization properties for Jira integration.
assignee
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
custom_fields
\nobject
Map of custom field identifiers to their sync configurations.
<any-key>
\nobject
Synchronization configuration for a Jira custom field.
sync_type
\nstring
The type of synchronization to apply for this custom field.
value
\nobject <oneOf>
Represents any valid JSON value.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\n[ <oneOf>]
An array of arbitrary values.
Object 1
\nstring
A scalar value represented as a string.
Object 2
\ndouble
A scalar numeric value.
Object 3
\nobject
An arbitrary object value with additional properties.
Object 4
\nboolean
A scalar boolean value.
Object 5
\nboolean
A scalar boolean value.
description
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
due_date
\nobject
Due date synchronization configuration for Jira integration.
jira_field_id
\nstring
The Jira field identifier used to store the due date.
sync_type
\nstring
The type of synchronization to apply for the due date field.
priority
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
title
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
integration_monitor
\nobject
Monitor integration settings.
auto_resolve_enabled
\nboolean
Whether auto-resolve is enabled.
case_type_id
\nstring
Case type ID for monitor integration.
enabled
\nboolean
Whether monitor integration is enabled.
handle
\nstring
Monitor handle.
integration_on_call
\nobject
On-Call integration settings.
auto_assign_on_call
\nboolean
Whether to auto-assign on-call.
enabled
\nboolean
Whether On-Call integration is enabled.
escalation_queries
\n[object]
List of escalation queries for routing cases to on-call responders.
enabled
\nboolean
Whether this escalation query is enabled.
id
\nstring
Unique identifier of the escalation query.
query
\nstring
The query used to match cases for escalation.
target
\nobject
The target recipient for an On-Call escalation query.
dynamic_team_paging
\nboolean
Whether to use dynamic team paging for escalation.
team_id
\nstring
The identifier of the team to escalate to.
user_id
\nstring
The identifier of the user to escalate to.
integration_service_now
\nobject
ServiceNow integration settings.
assignment_group
\nstring
Assignment group.
auto_creation
\nobject
Auto-creation settings for ServiceNow incidents from cases.
enabled
\nboolean
Whether automatic ServiceNow incident creation is enabled.
enabled
\nboolean
Whether ServiceNow integration is enabled.
instance_name
\nstring
ServiceNow instance name.
sync_config
\nobject
Synchronization configuration for ServiceNow integration.
enabled
\nboolean
Whether ServiceNow synchronization is enabled.
properties
\nobject
Field-level synchronization properties for ServiceNow integration.
comments
\nobject
Sync property configuration.
sync_type
\nstring
The direction and type of synchronization for this property.
priority
\nobject
Priority synchronization configuration for ServiceNow integration.
impact_mapping
\nobject
Mapping of case priority values to ServiceNow impact values.
<any-key>
\nstring
sync_type
\nstring
The type of synchronization to apply for priority.
urgency_mapping
\nobject
Mapping of case priority values to ServiceNow urgency values.
<any-key>
\nstring
status
\nobject
Sync property with mapping configuration.
mapping
\nobject
Map of source values to destination values for synchronization.
<any-key>
\nstring
name_mapping
\nobject
Map of source names to display names used during synchronization.
<any-key>
\nstring
sync_type
\nstring
The direction and type of synchronization for this property.
notification
\nobject
Project notification settings.
destinations
\n[integer]
Notification destinations (1=email, 2=slack, 3=in-app).
enabled
\nboolean
Whether notifications are enabled.
notify_on_case_assignment
\nboolean
Whether to send a notification when a case is assigned.
notify_on_case_closed
\nboolean
Whether to send a notification when a case is closed.
notify_on_case_comment
\nboolean
Whether to send a notification when a comment is added to a case.
notify_on_case_comment_mention
\nboolean
Whether to send a notification when a user is mentioned in a case comment.
notify_on_case_priority_change
\nboolean
Whether to send a notification when a case's priority changes.
notify_on_case_status_change
\nboolean
Whether to send a notification when a case's status changes.
notify_on_case_unassignment
\nboolean
Whether to send a notification when a case is unassigned.
team_uuid
\nstring
Team UUID to associate with the project.
type [required]
\nenum
Project resource type. \nAllowed enum values: project
default: project