Skip to content

Commit edc9dba

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 1998a4d of spec repo
1 parent d79d730 commit edc9dba

7 files changed

Lines changed: 511 additions & 0 deletions

File tree

config/_default/menus/api.en.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9966,6 +9966,22 @@ menu:
99669966
- ListProcesses
99679967
unstable: []
99689968
order: 1
9969+
- name: Product Analytics
9970+
url: /api/latest/product-analytics/
9971+
identifier: product-analytics
9972+
generated: true
9973+
- name: Send server-side events
9974+
url: '#send-server-side-events'
9975+
identifier: product-analytics-send-server-side-events
9976+
parent: product-analytics
9977+
generated: true
9978+
params:
9979+
versions:
9980+
- v2
9981+
operationids:
9982+
- SubmitProductAnalyticsEvent
9983+
unstable: []
9984+
order: 1
99699985
- name: RUM
99709986
url: /api/latest/rum/
99719987
identifier: rum
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
title: Product Analytics
3+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Product Analytics
3+
headless: true
4+
---

content/en/api/v2/product-analytics/examples.json

Lines changed: 145 additions & 0 deletions
Large diffs are not rendered by default.

data/api/v2/full_spec.yaml

Lines changed: 333 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41471,6 +41471,114 @@ components:
4147141471
type: string
4147241472
x-enum-varnames:
4147341473
- PROCESS
41474+
ProductAnalyticsServerSideEventError:
41475+
description: Error details.
41476+
properties:
41477+
detail:
41478+
description: Error message.
41479+
example: Malformed payload
41480+
type: string
41481+
status:
41482+
description: Error code.
41483+
example: '400'
41484+
type: string
41485+
title:
41486+
description: Error title.
41487+
example: Bad Request
41488+
type: string
41489+
type: object
41490+
ProductAnalyticsServerSideEventErrors:
41491+
description: Error response.
41492+
properties:
41493+
errors:
41494+
description: Structured errors.
41495+
items:
41496+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventError'
41497+
type: array
41498+
type: object
41499+
ProductAnalyticsServerSideEventItem:
41500+
description: A Product Analytics server-side event.
41501+
properties:
41502+
account:
41503+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemAccount'
41504+
application:
41505+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemApplication'
41506+
event:
41507+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemEvent'
41508+
session:
41509+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemSession'
41510+
type:
41511+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemType'
41512+
usr:
41513+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItemUsr'
41514+
required:
41515+
- application
41516+
- event
41517+
- type
41518+
type: object
41519+
ProductAnalyticsServerSideEventItemAccount:
41520+
description: The account linked to your event.
41521+
properties:
41522+
id:
41523+
description: The account ID used in Datadog.
41524+
example: account-67890
41525+
type: string
41526+
required:
41527+
- id
41528+
type: object
41529+
ProductAnalyticsServerSideEventItemApplication:
41530+
description: The application in which you want to send your events.
41531+
properties:
41532+
id:
41533+
description: 'The application ID of your application. It can be found in
41534+
your
41535+
41536+
[application management page](https://app.datadoghq.com/rum/list).'
41537+
example: 123abcde-123a-123b-1234-123456789abc
41538+
type: string
41539+
required:
41540+
- id
41541+
type: object
41542+
ProductAnalyticsServerSideEventItemEvent:
41543+
description: Fields used for the event.
41544+
properties:
41545+
name:
41546+
description: The name of your event, which is used for search in the same
41547+
way as view or action names.
41548+
example: payment.processed
41549+
type: string
41550+
required:
41551+
- name
41552+
type: object
41553+
ProductAnalyticsServerSideEventItemSession:
41554+
description: The session linked to your event.
41555+
properties:
41556+
id:
41557+
description: The session ID captured by the SDK.
41558+
example: session-abcdef
41559+
type: string
41560+
required:
41561+
- id
41562+
type: object
41563+
ProductAnalyticsServerSideEventItemType:
41564+
description: The type of Product Analytics event. Must be `server` for server-side
41565+
events.
41566+
enum:
41567+
- server
41568+
example: server
41569+
type: string
41570+
x-enum-varnames:
41571+
- SERVER
41572+
ProductAnalyticsServerSideEventItemUsr:
41573+
description: The user linked to your event.
41574+
properties:
41575+
id:
41576+
description: The user ID used in Datadog.
41577+
example: user-12345
41578+
type: string
41579+
required:
41580+
- id
41581+
type: object
4147441582
Project:
4147541583
description: A Project
4147641584
properties:
@@ -78514,6 +78622,219 @@ paths:
7851478622
x-permission:
7851578623
operator: OPEN
7851678624
permissions: []
78625+
/api/v2/prodlytics:
78626+
post:
78627+
description: 'Send server-side events to Product Analytics. Server-side events
78628+
are retained for 15 months.
78629+
78630+
78631+
Server-Side events in Product Analytics are helpful for tracking events that
78632+
occur on the server,
78633+
78634+
as opposed to client-side events, which are captured by Real User Monitoring
78635+
(RUM) SDKs.
78636+
78637+
This allows for a more comprehensive view of the user journey by including
78638+
actions that happen on the server.
78639+
78640+
Typical examples could be `checkout.completed` or `payment.processed`.
78641+
78642+
78643+
Ingested server-side events are integrated into Product Analytics to allow
78644+
users to select and filter
78645+
78646+
these events in the event picker, similar to how views or actions are handled.
78647+
78648+
78649+
**Requirements:**
78650+
78651+
- At least one of `usr`, `account`, or `session` must be provided with a valid
78652+
ID.
78653+
78654+
- The `application.id` must reference a Product Analytics-enabled application.
78655+
78656+
78657+
**Custom Attributes:**
78658+
78659+
Any additional fields in the payload are flattened and searchable as facets.
78660+
78661+
For example, a payload with `{"customer": {"tier": "premium"}}` is searchable
78662+
with
78663+
78664+
the syntax `@customer.tier:premium` in Datadog.
78665+
78666+
78667+
The status codes answered by the HTTP API are:
78668+
78669+
- 202: Accepted: The request has been accepted for processing
78670+
78671+
- 400: Bad request (likely an issue in the payload formatting)
78672+
78673+
- 401: Unauthorized (likely a missing API Key)
78674+
78675+
- 403: Permission issue (likely using an invalid API Key)
78676+
78677+
- 408: Request Timeout, request should be retried after some time
78678+
78679+
- 413: Payload too large (batch is above 5MB uncompressed)
78680+
78681+
- 429: Too Many Requests, request should be retried after some time
78682+
78683+
- 500: Internal Server Error, the server encountered an unexpected condition
78684+
that prevented it from fulfilling the request, request should be retried after
78685+
some time
78686+
78687+
- 503: Service Unavailable, the server is not ready to handle the request
78688+
probably because it is overloaded, request should be retried after some time'
78689+
operationId: SubmitProductAnalyticsEvent
78690+
requestBody:
78691+
content:
78692+
application/json:
78693+
examples:
78694+
event-with-account:
78695+
description: Send a server-side event linked to an account.
78696+
summary: Event with account ID
78697+
value:
78698+
account:
78699+
id: account-456
78700+
application:
78701+
id: 123abcde-123a-123b-1234-123456789abc
78702+
event:
78703+
name: checkout.completed
78704+
type: server
78705+
event-with-custom-attributes:
78706+
description: Send a server-side event with additional custom attributes.
78707+
summary: Event with custom attributes
78708+
value:
78709+
application:
78710+
id: 123abcde-123a-123b-1234-123456789abc
78711+
customer:
78712+
tier: premium
78713+
event:
78714+
name: payment.processed
78715+
type: server
78716+
usr:
78717+
id: '123'
78718+
event-with-session:
78719+
description: Send a server-side event linked to a session.
78720+
summary: Event with session ID
78721+
value:
78722+
application:
78723+
id: 123abcde-123a-123b-1234-123456789abc
78724+
event:
78725+
name: form.submitted
78726+
session:
78727+
id: session-789
78728+
type: server
78729+
simple-event-with-user:
78730+
description: Send a server-side event linked to a user.
78731+
summary: Simple event with user ID
78732+
value:
78733+
application:
78734+
id: 123abcde-123a-123b-1234-123456789abc
78735+
event:
78736+
name: payment.processed
78737+
type: server
78738+
usr:
78739+
id: '123'
78740+
schema:
78741+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventItem'
78742+
description: Server-side event to send (JSON format).
78743+
required: true
78744+
responses:
78745+
'202':
78746+
content:
78747+
application/json:
78748+
schema:
78749+
type: object
78750+
description: Request accepted for processing (always 202 empty JSON).
78751+
'400':
78752+
content:
78753+
application/json:
78754+
schema:
78755+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78756+
description: Bad Request
78757+
'401':
78758+
content:
78759+
application/json:
78760+
schema:
78761+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78762+
description: Unauthorized
78763+
'403':
78764+
content:
78765+
application/json:
78766+
schema:
78767+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78768+
description: Forbidden
78769+
'408':
78770+
content:
78771+
application/json:
78772+
schema:
78773+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78774+
description: Request Timeout
78775+
'413':
78776+
content:
78777+
application/json:
78778+
schema:
78779+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78780+
description: Payload Too Large
78781+
'429':
78782+
content:
78783+
application/json:
78784+
schema:
78785+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78786+
description: Too Many Requests
78787+
'500':
78788+
content:
78789+
application/json:
78790+
schema:
78791+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78792+
description: Internal Server Error
78793+
'503':
78794+
content:
78795+
application/json:
78796+
schema:
78797+
$ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78798+
description: Service Unavailable
78799+
security:
78800+
- apiKeyAuth: []
78801+
servers:
78802+
- url: https://{subdomain}.{site}
78803+
variables:
78804+
site:
78805+
default: datadoghq.com
78806+
description: The regional site for customers.
78807+
enum:
78808+
- datadoghq.com
78809+
- us3.datadoghq.com
78810+
- us5.datadoghq.com
78811+
- ap1.datadoghq.com
78812+
- ap2.datadoghq.com
78813+
- datadoghq.eu
78814+
subdomain:
78815+
default: browser-intake
78816+
description: The subdomain where the API is deployed.
78817+
- url: '{protocol}://{name}'
78818+
variables:
78819+
name:
78820+
default: browser-intake-datadoghq.com
78821+
description: Full site DNS name.
78822+
protocol:
78823+
default: https
78824+
description: The protocol for accessing the API.
78825+
- url: https://{subdomain}.{site}
78826+
variables:
78827+
site:
78828+
default: datadoghq.com
78829+
description: Any Datadog deployment.
78830+
subdomain:
78831+
default: browser-intake
78832+
description: The subdomain where the API is deployed.
78833+
summary: Send server-side events
78834+
tags:
78835+
- Product Analytics
78836+
x-codegen-request-body-name: body
78837+
x-menu-order: 1
7851778838
/api/v2/product-analytics/accounts/facet_info:
7851878839
post:
7851978840
description: Get facet information for account attributes including possible
@@ -91545,6 +91866,18 @@ tags:
9154591866
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
9154691867
for more information.
9154791868
name: Processes
91869+
- description: 'Send server-side events to Product Analytics. Server-Side Events Ingestion
91870+
allows you to collect custom events
91871+
91872+
from any server-side source, and retains events for 15 months. Server-side events
91873+
are helpful for understanding
91874+
91875+
causes of a funnel drop-off which are external to the client-side (for example,
91876+
payment processing error).
91877+
91878+
See the [Product Analytics page](https://docs.datadoghq.com/product_analytics/)
91879+
for more information.'
91880+
name: Product Analytics
9154891881
- description: Manage your Real User Monitoring (RUM) applications, and search or
9154991882
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
9155091883
for more information

data/api/v2/translate_actions.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2141,6 +2141,12 @@
21412141
"description": "Get all processes for your organization.",
21422142
"summary": "Get all processes"
21432143
},
2144+
"SubmitProductAnalyticsEvent": {
2145+
"description": "Send server-side events to Product Analytics. Server-side events are retained for 15 months.\n\nServer-Side events in Product Analytics are helpful for tracking events that occur on the server,\nas opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs.\nThis allows for a more comprehensive view of the user journey by including actions that happen on the server.\nTypical examples could be `checkout.completed` or `payment.processed`.\n\nIngested server-side events are integrated into Product Analytics to allow users to select and filter\nthese events in the event picker, similar to how views or actions are handled.\n\n**Requirements:**\n- At least one of `usr`, `account`, or `session` must be provided with a valid ID.\n- The `application.id` must reference a Product Analytics-enabled application.\n\n**Custom Attributes:**\nAny additional fields in the payload are flattened and searchable as facets.\nFor example, a payload with `{\"customer\": {\"tier\": \"premium\"}}` is searchable with\nthe syntax `@customer.tier:premium` in Datadog.\n\nThe status codes answered by the HTTP API are:\n- 202: Accepted: The request has been accepted for processing\n- 400: Bad request (likely an issue in the payload formatting)\n- 401: Unauthorized (likely a missing API Key)\n- 403: Permission issue (likely using an invalid API Key)\n- 408: Request Timeout, request should be retried after some time\n- 413: Payload too large (batch is above 5MB uncompressed)\n- 429: Too Many Requests, request should be retried after some time\n- 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time\n- 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time",
2146+
"summary": "Send server-side events",
2147+
"request_description": "Server-side event to send (JSON format).",
2148+
"request_schema_description": "A Product Analytics server-side event."
2149+
},
21442150
"GetAccountFacetInfo": {
21452151
"description": "Get facet information for account attributes including possible values and counts",
21462152
"summary": "Get account facet info",

0 commit comments

Comments
 (0)