@@ -41294,6 +41294,121 @@ components:
4129441294 type: string
4129541295 x-enum-varnames:
4129641296 - PROCESS
41297+ ProductAnalyticsServerSideEventError:
41298+ description: Error details.
41299+ properties:
41300+ detail:
41301+ description: Error message.
41302+ example: Malformed payload
41303+ type: string
41304+ status:
41305+ description: Error code.
41306+ example: '400'
41307+ type: string
41308+ title:
41309+ description: Error title.
41310+ example: Bad Request
41311+ type: string
41312+ type: object
41313+ ProductAnalyticsServerSideEventErrors:
41314+ description: Error response.
41315+ properties:
41316+ errors:
41317+ description: Structured errors.
41318+ items:
41319+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventError'
41320+ type: array
41321+ type: object
41322+ ProductAnalyticsServerSideEventItem:
41323+ additionalProperties:
41324+ description: 'Any additional facet you want to be able to use when searching
41325+ for events in Datadog.
41326+
41327+ These are flattened. For example, `{"customer": {"tier": "premium"}}` is
41328+
41329+ searchable with the syntax `@customer.tier:premium` in Datadog.'
41330+ description: A Product Analytics server-side event.
41331+ properties:
41332+ account:
41333+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemAccount'
41334+ application:
41335+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemApplication'
41336+ event:
41337+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemEvent'
41338+ session:
41339+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemSession'
41340+ type:
41341+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemType'
41342+ usr:
41343+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemUsr'
41344+ required:
41345+ - application
41346+ - event
41347+ - type
41348+ type: object
41349+ ProductAnalyticsServerSideEventItemAccount:
41350+ description: The account linked to your event.
41351+ properties:
41352+ id:
41353+ description: The account ID used in Datadog.
41354+ example: account-67890
41355+ type: string
41356+ required:
41357+ - id
41358+ type: object
41359+ ProductAnalyticsServerSideEventItemApplication:
41360+ description: The application in which you want to send your events.
41361+ properties:
41362+ id:
41363+ description: 'The application ID of your application. It can be found in
41364+ your
41365+
41366+ [application management page](https://app.datadoghq.com/rum/list).'
41367+ example: 123abcde-123a-123b-1234-123456789abc
41368+ type: string
41369+ required:
41370+ - id
41371+ type: object
41372+ ProductAnalyticsServerSideEventItemEvent:
41373+ description: Fields used for the event.
41374+ properties:
41375+ name:
41376+ description: The name of your event, which is used for search in the same
41377+ way as view or action names.
41378+ example: payment.processed
41379+ type: string
41380+ required:
41381+ - name
41382+ type: object
41383+ ProductAnalyticsServerSideEventItemSession:
41384+ description: The session linked to your event.
41385+ properties:
41386+ id:
41387+ description: The session ID captured by the SDK.
41388+ example: session-abcdef
41389+ type: string
41390+ required:
41391+ - id
41392+ type: object
41393+ ProductAnalyticsServerSideEventItemType:
41394+ description: The type of Product Analytics event. Must be `server` for server-side
41395+ events.
41396+ enum:
41397+ - server
41398+ example: server
41399+ type: string
41400+ x-enum-varnames:
41401+ - SERVER
41402+ ProductAnalyticsServerSideEventItemUsr:
41403+ description: The user linked to your event.
41404+ properties:
41405+ id:
41406+ description: The user ID used in Datadog.
41407+ example: user-12345
41408+ type: string
41409+ required:
41410+ - id
41411+ type: object
4129741412 Project:
4129841413 description: A Project
4129941414 properties:
@@ -78433,6 +78548,219 @@ paths:
7843378548 x-permission:
7843478549 operator: OPEN
7843578550 permissions: []
78551+ /api/v2/prodlytics:
78552+ post:
78553+ description: 'Send server-side events to Product Analytics. Server-side events
78554+ are retained for 15 months.
78555+
78556+
78557+ Server-Side events in Product Analytics are helpful for tracking events that
78558+ occur on the server,
78559+
78560+ as opposed to client-side events, which are captured by Real User Monitoring
78561+ (RUM) SDKs.
78562+
78563+ This allows for a more comprehensive view of the user journey by including
78564+ actions that happen on the server.
78565+
78566+ Typical examples could be `checkout.completed` or `payment.processed`.
78567+
78568+
78569+ Ingested server-side events are integrated into Product Analytics to allow
78570+ users to select and filter
78571+
78572+ these events in the event picker, similar to how views or actions are handled.
78573+
78574+
78575+ **Requirements:**
78576+
78577+ - At least one of `usr`, `account`, or `session` must be provided with a valid
78578+ ID.
78579+
78580+ - The `application.id` must reference a Product Analytics-enabled application.
78581+
78582+
78583+ **Custom Attributes:**
78584+
78585+ Any additional fields in the payload are flattened and searchable as facets.
78586+
78587+ For example, a payload with `{"customer": {"tier": "premium"}}` is searchable
78588+ with
78589+
78590+ the syntax `@customer.tier:premium` in Datadog.
78591+
78592+
78593+ The status codes answered by the HTTP API are:
78594+
78595+ - 202: Accepted: The request has been accepted for processing
78596+
78597+ - 400: Bad request (likely an issue in the payload formatting)
78598+
78599+ - 401: Unauthorized (likely a missing API Key)
78600+
78601+ - 403: Permission issue (likely using an invalid API Key)
78602+
78603+ - 408: Request Timeout, request should be retried after some time
78604+
78605+ - 413: Payload too large (batch is above 5MB uncompressed)
78606+
78607+ - 429: Too Many Requests, request should be retried after some time
78608+
78609+ - 500: Internal Server Error, the server encountered an unexpected condition
78610+ that prevented it from fulfilling the request, request should be retried after
78611+ some time
78612+
78613+ - 503: Service Unavailable, the server is not ready to handle the request
78614+ probably because it is overloaded, request should be retried after some time'
78615+ operationId: SubmitProductAnalyticsEvent
78616+ requestBody:
78617+ content:
78618+ application/json:
78619+ examples:
78620+ event-with-account:
78621+ description: Send a server-side event linked to an account.
78622+ summary: Event with account ID
78623+ value:
78624+ account:
78625+ id: account-456
78626+ application:
78627+ id: 123abcde-123a-123b-1234-123456789abc
78628+ event:
78629+ name: checkout.completed
78630+ type: server
78631+ event-with-custom-attributes:
78632+ description: Send a server-side event with additional custom attributes.
78633+ summary: Event with custom attributes
78634+ value:
78635+ application:
78636+ id: 123abcde-123a-123b-1234-123456789abc
78637+ customer:
78638+ tier: premium
78639+ event:
78640+ name: payment.processed
78641+ type: server
78642+ usr:
78643+ id: '123'
78644+ event-with-session:
78645+ description: Send a server-side event linked to a session.
78646+ summary: Event with session ID
78647+ value:
78648+ application:
78649+ id: 123abcde-123a-123b-1234-123456789abc
78650+ event:
78651+ name: form.submitted
78652+ session:
78653+ id: session-789
78654+ type: server
78655+ simple-event-with-user:
78656+ description: Send a server-side event linked to a user.
78657+ summary: Simple event with user ID
78658+ value:
78659+ application:
78660+ id: 123abcde-123a-123b-1234-123456789abc
78661+ event:
78662+ name: payment.processed
78663+ type: server
78664+ usr:
78665+ id: '123'
78666+ schema:
78667+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItem'
78668+ description: Server-side event to send (JSON format).
78669+ required: true
78670+ responses:
78671+ '202':
78672+ content:
78673+ application/json:
78674+ schema:
78675+ type: object
78676+ description: Request accepted for processing (always 202 empty JSON).
78677+ '400':
78678+ content:
78679+ application/json:
78680+ schema:
78681+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78682+ description: Bad Request
78683+ '401':
78684+ content:
78685+ application/json:
78686+ schema:
78687+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78688+ description: Unauthorized
78689+ '403':
78690+ content:
78691+ application/json:
78692+ schema:
78693+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78694+ description: Forbidden
78695+ '408':
78696+ content:
78697+ application/json:
78698+ schema:
78699+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78700+ description: Request Timeout
78701+ '413':
78702+ content:
78703+ application/json:
78704+ schema:
78705+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78706+ description: Payload Too Large
78707+ '429':
78708+ content:
78709+ application/json:
78710+ schema:
78711+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78712+ description: Too Many Requests
78713+ '500':
78714+ content:
78715+ application/json:
78716+ schema:
78717+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78718+ description: Internal Server Error
78719+ '503':
78720+ content:
78721+ application/json:
78722+ schema:
78723+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
78724+ description: Service Unavailable
78725+ security:
78726+ - apiKeyAuth: []
78727+ servers:
78728+ - url: https://{subdomain}.{site}
78729+ variables:
78730+ site:
78731+ default: datadoghq.com
78732+ description: The regional site for customers.
78733+ enum:
78734+ - datadoghq.com
78735+ - us3.datadoghq.com
78736+ - us5.datadoghq.com
78737+ - ap1.datadoghq.com
78738+ - ap2.datadoghq.com
78739+ - datadoghq.eu
78740+ subdomain:
78741+ default: browser-intake
78742+ description: The subdomain where the API is deployed.
78743+ - url: '{protocol}://{name}'
78744+ variables:
78745+ name:
78746+ default: browser-intake-datadoghq.com
78747+ description: Full site DNS name.
78748+ protocol:
78749+ default: https
78750+ description: The protocol for accessing the API.
78751+ - url: https://{subdomain}.{site}
78752+ variables:
78753+ site:
78754+ default: datadoghq.com
78755+ description: Any Datadog deployment.
78756+ subdomain:
78757+ default: browser-intake
78758+ description: The subdomain where the API is deployed.
78759+ summary: Send server-side events
78760+ tags:
78761+ - Product Analytics
78762+ x-codegen-request-body-name: body
78763+ x-menu-order: 1
7843678764 /api/v2/product-analytics/accounts/facet_info:
7843778765 post:
7843878766 description: Get facet information for account attributes including possible
@@ -91464,6 +91792,18 @@ tags:
9146491792 See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
9146591793 for more information.
9146691794 name: Processes
91795+ - description: 'Send server-side events to Product Analytics. Server-Side Events Ingestion
91796+ allows you to collect custom events
91797+
91798+ from any server-side source, and retains events for 15 months. Server-side events
91799+ are helpful for understanding
91800+
91801+ causes of a funnel drop-off which are external to the client-side (for example,
91802+ payment processing error).
91803+
91804+ See the [Product Analytics page](https://docs.datadoghq.com/product_analytics/)
91805+ for more information.'
91806+ name: Product Analytics
9146791807- description: Manage your Real User Monitoring (RUM) applications, and search or
9146891808 aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
9146991809 for more information
0 commit comments