@@ -41060,6 +41060,121 @@ components:
4106041060 type: string
4106141061 x-enum-varnames:
4106241062 - PROCESS
41063+ ProductAnalyticsServerSideEventError:
41064+ description: Error details.
41065+ properties:
41066+ detail:
41067+ description: Error message.
41068+ example: Malformed payload
41069+ type: string
41070+ status:
41071+ description: Error code.
41072+ example: '400'
41073+ type: string
41074+ title:
41075+ description: Error title.
41076+ example: Bad Request
41077+ type: string
41078+ type: object
41079+ ProductAnalyticsServerSideEventErrors:
41080+ description: Error response.
41081+ properties:
41082+ errors:
41083+ description: Structured errors.
41084+ items:
41085+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventError'
41086+ type: array
41087+ type: object
41088+ ProductAnalyticsServerSideEventItem:
41089+ additionalProperties:
41090+ description: 'Any additional facet you want to be able to use when searching
41091+ for events in Datadog.
41092+
41093+ These are flattened. For example, `{"customer": {"tier": "premium"}}` is
41094+
41095+ searchable with the syntax `@customer.tier:premium` in Datadog.'
41096+ description: A Product Analytics server-side event.
41097+ properties:
41098+ account:
41099+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemAccount'
41100+ application:
41101+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemApplication'
41102+ event:
41103+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemEvent'
41104+ session:
41105+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemSession'
41106+ type:
41107+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemType'
41108+ usr:
41109+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemUsr'
41110+ required:
41111+ - application
41112+ - event
41113+ - type
41114+ type: object
41115+ ProductAnalyticsServerSideEventItemAccount:
41116+ description: The account linked to your event.
41117+ properties:
41118+ id:
41119+ description: The account ID used in Datadog.
41120+ example: account-67890
41121+ type: string
41122+ required:
41123+ - id
41124+ type: object
41125+ ProductAnalyticsServerSideEventItemApplication:
41126+ description: The application in which you want to send your events.
41127+ properties:
41128+ id:
41129+ description: 'The application ID of your application. It can be found in
41130+ your
41131+
41132+ [application management page](https://app.datadoghq.com/rum/list).'
41133+ example: 123abcde-123a-123b-1234-123456789abc
41134+ type: string
41135+ required:
41136+ - id
41137+ type: object
41138+ ProductAnalyticsServerSideEventItemEvent:
41139+ description: Fields used for the event.
41140+ properties:
41141+ name:
41142+ description: The name of your event, which is used for search in the same
41143+ way as view or action names.
41144+ example: payment.processed
41145+ type: string
41146+ required:
41147+ - name
41148+ type: object
41149+ ProductAnalyticsServerSideEventItemSession:
41150+ description: The session linked to your event.
41151+ properties:
41152+ id:
41153+ description: The session ID captured by the SDK.
41154+ example: session-abcdef
41155+ type: string
41156+ required:
41157+ - id
41158+ type: object
41159+ ProductAnalyticsServerSideEventItemType:
41160+ description: The type of Product Analytics event. Must be `server` for server-side
41161+ events.
41162+ enum:
41163+ - server
41164+ example: server
41165+ type: string
41166+ x-enum-varnames:
41167+ - SERVER
41168+ ProductAnalyticsServerSideEventItemUsr:
41169+ description: The user linked to your event.
41170+ properties:
41171+ id:
41172+ description: The user ID used in Datadog.
41173+ example: user-12345
41174+ type: string
41175+ required:
41176+ - id
41177+ type: object
4106341178 Project:
4106441179 description: A Project
4106541180 properties:
@@ -77928,6 +78043,218 @@ paths:
7792878043 x-permission:
7792978044 operator: OPEN
7793078045 permissions: []
78046+ /api/v2/prodlytics:
78047+ post:
78048+ description: 'Send server-side events to Product Analytics. Server-side events
78049+ are retained for 15 months.
78050+
78051+
78052+ Server-Side events in Product Analytics are helpful for tracking events that
78053+ occur on the server,
78054+
78055+ as opposed to client-side events, which are captured by Real User Monitoring
78056+ (RUM) SDKs.
78057+
78058+ This allows for a more comprehensive view of the user journey by including
78059+ actions that happen on the server.
78060+
78061+ Typical examples could be `checkout.completed` or `payment.processed`.
78062+
78063+
78064+ Ingested server-side events are integrated into Product Analytics to allow
78065+ users to select and filter
78066+
78067+ these events in the event picker, similar to how views or actions are handled.
78068+
78069+
78070+ **Requirements:**
78071+
78072+ - At least one of `usr`, `account`, or `session` must be provided with a valid
78073+ ID.
78074+
78075+ - The `application.id` must reference a Product Analytics-enabled application.
78076+
78077+
78078+ **Custom Attributes:**
78079+
78080+ Any additional fields in the payload are flattened and searchable as facets.
78081+
78082+ For example, a payload with `{"customer": {"tier": "premium"}}` is searchable
78083+ with
78084+
78085+ the syntax `@customer.tier:premium` in Datadog.
78086+
78087+
78088+ The status codes answered by the HTTP API are:
78089+
78090+ - 202: Accepted: The request has been accepted for processing
78091+
78092+ - 400: Bad request (likely an issue in the payload formatting)
78093+
78094+ - 401: Unauthorized (likely a missing API Key)
78095+
78096+ - 403: Permission issue (likely using an invalid API Key)
78097+
78098+ - 408: Request Timeout, request should be retried after some time
78099+
78100+ - 413: Payload too large (batch is above 5MB uncompressed)
78101+
78102+ - 429: Too Many Requests, request should be retried after some time
78103+
78104+ - 500: Internal Server Error, the server encountered an unexpected condition
78105+ that prevented it from fulfilling the request, request should be retried after
78106+ some time
78107+
78108+ - 503: Service Unavailable, the server is not ready to handle the request
78109+ probably because it is overloaded, request should be retried after some time'
78110+ operationId: SubmitProductAnalyticsEvent
78111+ requestBody:
78112+ content:
78113+ application/json:
78114+ examples:
78115+ event-with-account:
78116+ description: Send a server-side event linked to an account.
78117+ summary: Event with account ID
78118+ value:
78119+ account:
78120+ id: account-456
78121+ application:
78122+ id: 123abcde-123a-123b-1234-123456789abc
78123+ event:
78124+ name: checkout.completed
78125+ type: server
78126+ event-with-custom-attributes:
78127+ description: Send a server-side event with additional custom attributes.
78128+ summary: Event with custom attributes
78129+ value:
78130+ application:
78131+ id: 123abcde-123a-123b-1234-123456789abc
78132+ customer:
78133+ tier: premium
78134+ event:
78135+ name: payment.processed
78136+ type: server
78137+ usr:
78138+ id: '123'
78139+ event-with-session:
78140+ description: Send a server-side event linked to a session.
78141+ summary: Event with session ID
78142+ value:
78143+ application:
78144+ id: 123abcde-123a-123b-1234-123456789abc
78145+ event:
78146+ name: form.submitted
78147+ session:
78148+ id: session-789
78149+ type: server
78150+ simple-event-with-user:
78151+ description: Send a server-side event linked to a user.
78152+ summary: Simple event with user ID
78153+ value:
78154+ application:
78155+ id: 123abcde-123a-123b-1234-123456789abc
78156+ event:
78157+ name: payment.processed
78158+ type: server
78159+ usr:
78160+ id: '123'
78161+ schema:
78162+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItem'
78163+ description: Server-side event to send (JSON format).
78164+ required: true
78165+ responses:
78166+ '202':
78167+ content:
78168+ application/json:
78169+ schema:
78170+ type: object
78171+ description: Request accepted for processing (always 202 empty JSON).
78172+ '400':
78173+ content:
78174+ application/json:
78175+ schema:
78176+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78177+ description: Bad Request
78178+ '401':
78179+ content:
78180+ application/json:
78181+ schema:
78182+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78183+ description: Unauthorized
78184+ '403':
78185+ content:
78186+ application/json:
78187+ schema:
78188+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78189+ description: Forbidden
78190+ '408':
78191+ content:
78192+ application/json:
78193+ schema:
78194+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78195+ description: Request Timeout
78196+ '413':
78197+ content:
78198+ application/json:
78199+ schema:
78200+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78201+ description: Payload Too Large
78202+ '429':
78203+ content:
78204+ application/json:
78205+ schema:
78206+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78207+ description: Too Many Requests
78208+ '500':
78209+ content:
78210+ application/json:
78211+ schema:
78212+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78213+ description: Internal Server Error
78214+ '503':
78215+ content:
78216+ application/json:
78217+ schema:
78218+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78219+ description: Service Unavailable
78220+ security:
78221+ - apiKeyAuth: []
78222+ servers:
78223+ - url: https://{subdomain}.{site}
78224+ variables:
78225+ site:
78226+ default: datadoghq.com
78227+ description: The regional site for customers.
78228+ enum:
78229+ - datadoghq.com
78230+ - us3.datadoghq.com
78231+ - us5.datadoghq.com
78232+ - ap1.datadoghq.com
78233+ - ap2.datadoghq.com
78234+ - datadoghq.eu
78235+ subdomain:
78236+ default: browser-intake
78237+ description: The subdomain where the API is deployed.
78238+ - url: '{protocol}://{name}'
78239+ variables:
78240+ name:
78241+ default: browser-intake-datadoghq.com
78242+ description: Full site DNS name.
78243+ protocol:
78244+ default: https
78245+ description: The protocol for accessing the API.
78246+ - url: https://{subdomain}.{site}
78247+ variables:
78248+ site:
78249+ default: datadoghq.com
78250+ description: Any Datadog deployment.
78251+ subdomain:
78252+ default: browser-intake
78253+ description: The subdomain where the API is deployed.
78254+ summary: Send server-side events
78255+ tags:
78256+ - Product Analytics
78257+ x-codegen-request-body-name: body
7793178258 /api/v2/product-analytics/accounts/facet_info:
7793278259 post:
7793378260 description: Get facet information for account attributes including possible
@@ -90124,6 +90451,18 @@ tags:
9012490451 See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
9012590452 for more information.
9012690453 name: Processes
90454+ - description: 'Send server-side events to Product Analytics. Server-Side Events Ingestion
90455+ allows you to collect custom events
90456+
90457+ from any server-side source, and retains events for 15 months. Server-side events
90458+ are helpful for understanding
90459+
90460+ causes of a funnel drop-off which are external to the client-side (for example,
90461+ payment processing error).
90462+
90463+ See the [Product Analytics page](https://docs.datadoghq.com/product_analytics/)
90464+ for more information.'
90465+ name: Product Analytics
9012790466- description: Manage your Real User Monitoring (RUM) applications, and search or
9012890467 aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
9012990468 for more information
0 commit comments