diff --git a/content/en/api/v2/dora-metrics/examples.json b/content/en/api/v2/dora-metrics/examples.json index a3f71e8a55b..2f68c96edad 100644 --- a/content/en/api/v2/dora-metrics/examples.json +++ b/content/en/api/v2/dora-metrics/examples.json @@ -89,7 +89,7 @@ } } }, - "html": "
data [required]
\nobject
The JSON:API data.
attributes [required]
\nobject
Attributes to create a DORA deployment event.
custom_tags
\n[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env
\nstring
Environment name to where the service was deployed.
finished_at [required]
\nint64
Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds.
git
\nobject
Git info for DORA Metrics events.
commit_sha [required]
\nstring
Git Commit SHA.
repository_url [required]
\nstring
Git Repository URL
id
\nstring
Deployment ID.
service [required]
\nstring
Service name.
started_at [required]
\nint64
Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.
team
\nstring
Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.
data [required]
\nobject
The JSON:API data.
attributes [required]
\nobject
Attributes to create a DORA deployment event.
custom_tags
\n[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env
\nstring
Environment name to where the service was deployed.
finished_at [required]
\nint64
Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds.
git
\nobject
Git info for DORA Metrics events.
commit_sha [required]
\nstring
Git Commit SHA.
repository_url [required]
\nstring
Git Repository URL
id
\nstring
Deployment ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :).
service [required]
\nstring
Service name.
started_at [required]
\nint64
Unix timestamp when the deployment started. It must be in nanoseconds, milliseconds, or seconds.
team
\nstring
Name of the team owning the deployed service. If not provided, this is automatically populated with the team associated with the service in the Service Catalog.
data [required]
\nobject
The JSON:API data.
attributes [required]
\nobject
Attributes to create a DORA failure event.
custom_tags
\n[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env
\nstring
Environment name that was impacted by the failure.
finished_at
\nint64
Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds.
git
\nobject
Git info for DORA Metrics events.
commit_sha [required]
\nstring
Git Commit SHA.
repository_url [required]
\nstring
Git Repository URL
id
\nstring
Failure ID. Must have at least 16 characters. Required to update a previously sent failure.
name
\nstring
Failure name.
services
\n[string]
Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.
severity
\nstring
Failure severity.
started_at [required]
\nint64
Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.
team
\nstring
Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.
data [required]
\nobject
The JSON:API data.
attributes [required]
\nobject
Attributes to create a DORA failure event.
custom_tags
\n[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env
\nstring
Environment name that was impacted by the failure.
finished_at
\nint64
Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds.
git
\nobject
Git info for DORA Metrics events.
commit_sha [required]
\nstring
Git Commit SHA.
repository_url [required]
\nstring
Git Repository URL
id
\nstring
Failure ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :).
name
\nstring
Failure name.
services
\n[string]
Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.
severity
\nstring
Failure severity.
started_at [required]
\nint64
Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.
team
\nstring
Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.
data [required]
\nobject
The JSON:API data.
attributes [required]
\nobject
Attributes to create a DORA failure event.
custom_tags
\n[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env
\nstring
Environment name that was impacted by the failure.
finished_at
\nint64
Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds.
git
\nobject
Git info for DORA Metrics events.
commit_sha [required]
\nstring
Git Commit SHA.
repository_url [required]
\nstring
Git Repository URL
id
\nstring
Failure ID. Must have at least 16 characters. Required to update a previously sent failure.
name
\nstring
Failure name.
services
\n[string]
Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.
severity
\nstring
Failure severity.
started_at [required]
\nint64
Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.
team
\nstring
Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.
data [required]
\nobject
The JSON:API data.
attributes [required]
\nobject
Attributes to create a DORA failure event.
custom_tags
\n[string]
A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.
env
\nstring
Environment name that was impacted by the failure.
finished_at
\nint64
Unix timestamp when the failure finished. It must be in nanoseconds, milliseconds, or seconds.
git
\nobject
Git info for DORA Metrics events.
commit_sha [required]
\nstring
Git Commit SHA.
repository_url [required]
\nstring
Git Repository URL
id
\nstring
Failure ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :).
name
\nstring
Failure name.
services
\n[string]
Service names impacted by the failure. If possible, use names registered in the Service Catalog. Required when the team field is not provided.
severity
\nstring
Failure severity.
started_at [required]
\nint64
Unix timestamp when the failure started. It must be in nanoseconds, milliseconds, or seconds.
team
\nstring
Name of the team owning the services impacted. If possible, use team handles registered in Datadog. Required when the services field is not provided.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
errors
\n[object]
Structured errors.
detail
\nstring
Error message.
status
\nstring
Error code.
title
\nstring
Error title.
account
\nobject
The account linked to your event.
id [required]
\nstring
The account ID used in Datadog.
application [required]
\nobject
The application in which you want to send your events.
id [required]
\nstring
The application ID of your application. It can be found in your\napplication management page.
event [required]
\nobject
Fields used for the event.
name [required]
\nstring
The name of your event, which is used for search in the same way as view or action names.
session
\nobject
The session linked to your event.
id [required]
\nstring
The session ID captured by the SDK.
type [required]
\nenum
The type of Product Analytics event. Must be server for server-side events. \nAllowed enum values: server
usr
\nobject
The user linked to your event.
id [required]
\nstring
The user ID used in Datadog.
account
\nobject
The account linked to your event.
id [required]
\nstring
The account ID used in Datadog.
application [required]
\nobject
The application in which you want to send your events.
id [required]
\nstring
The application ID of your application. It can be found in your\napplication management page.
event [required]
\nobject
Fields used for the event.
name [required]
\nstring
The name of your event, which is used for search in the same way as view or action names.
session
\nobject
The session linked to your event.
id [required]
\nstring
The session ID captured by the SDK.
type [required]
\nenum
The type of Product Analytics event. Must be server for server-side events. \nAllowed enum values: server
usr
\nobject
The user linked to your event.
id [required]
\nstring
The user ID used in Datadog.