|
2240 | 2240 | </li></ul> |
2241 | 2241 | </nav> |
2242 | 2242 | </li> |
| 2243 | + <li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.product_analytics_api" class="md-nav__link">datadog_api_client.v2.api.product_analytics_api module</a><nav class="md-nav"> |
| 2244 | + <ul class="md-nav__list"> |
| 2245 | + <li class="md-nav__item"><a href="#datadog_api_client.v2.api.product_analytics_api.ProductAnalyticsApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ProductAnalyticsApi</span></code></a><nav class="md-nav"> |
| 2246 | + <ul class="md-nav__list"> |
| 2247 | + <li class="md-nav__item"><a href="#datadog_api_client.v2.api.product_analytics_api.ProductAnalyticsApi.submit_product_analytics_event" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ProductAnalyticsApi.submit_product_analytics_event()</span></code></a> |
| 2248 | + </li></ul> |
| 2249 | + </nav> |
| 2250 | + </li></ul> |
| 2251 | + </nav> |
| 2252 | + </li> |
2243 | 2253 | <li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.reference_tables_api" class="md-nav__link">datadog_api_client.v2.api.reference_tables_api module</a><nav class="md-nav"> |
2244 | 2254 | <ul class="md-nav__list"> |
2245 | 2255 | <li class="md-nav__item"><a href="#datadog_api_client.v2.api.reference_tables_api.ReferenceTablesApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ReferenceTablesApi</span></code></a><nav class="md-nav"> |
@@ -11412,6 +11422,59 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li |
11412 | 11422 | </dd></dl> |
11413 | 11423 | </dd></dl> |
11414 | 11424 | </section> |
| 11425 | +<section id="module-datadog_api_client.v2.api.product_analytics_api"> |
| 11426 | +<span id="datadog-api-client-v2-api-product-analytics-api-module"></span><h2 id="module-datadog_api_client.v2.api.product_analytics_api">datadog_api_client.v2.api.product_analytics_api module<a class="headerlink" href="#module-datadog_api_client.v2.api.product_analytics_api" title="Link to this heading">¶</a></h2> |
| 11427 | +<dl class="py class"> |
| 11428 | +<dt class="sig sig-object py" id="datadog_api_client.v2.api.product_analytics_api.ProductAnalyticsApi"> |
| 11429 | +<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ProductAnalyticsApi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.api.product_analytics_api.ProductAnalyticsApi" title="Link to this definition">¶</a></dt> |
| 11430 | +<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p> |
| 11431 | +<p>Send server-side events to Product Analytics. Server-Side Events Ingestion allows you to collect custom events |
| 11432 | +from any server-side source, and retains events for 15 months. Server-side events are helpful for understanding |
| 11433 | +causes of a funnel drop-off which are external to the client-side (for example, payment processing error). |
| 11434 | +See the <a class="reference external" href="https://docs.datadoghq.com/product_analytics/">Product Analytics page</a> for more information.</p> |
| 11435 | +<dl class="py method"> |
| 11436 | +<dt class="sig sig-object py" id="datadog_api_client.v2.api.product_analytics_api.ProductAnalyticsApi.submit_product_analytics_event"> |
| 11437 | +<span class="sig-name descname"><span class="pre">submit_product_analytics_event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.product_analytics_server_side_event_item.ProductAnalyticsServerSideEventItem" title="datadog_api_client.v2.model.product_analytics_server_side_event_item.ProductAnalyticsServerSideEventItem"><span class="pre">ProductAnalyticsServerSideEventItem</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.product_analytics_api.ProductAnalyticsApi.submit_product_analytics_event" title="Link to this definition">¶</a></dt> |
| 11438 | +<dd><p>Send server-side events.</p> |
| 11439 | +<p>Send server-side events to Product Analytics. Server-side events are retained for 15 months.</p> |
| 11440 | +<p>Server-Side events in Product Analytics are helpful for tracking events that occur on the server, |
| 11441 | +as opposed to client-side events, which are captured by Real User Monitoring (RUM) SDKs. |
| 11442 | +This allows for a more comprehensive view of the user journey by including actions that happen on the server. |
| 11443 | +Typical examples could be <code class="docutils literal notranslate"><span class="pre">checkout.completed</span></code> or <code class="docutils literal notranslate"><span class="pre">payment.processed</span></code>.</p> |
| 11444 | +<p>Ingested server-side events are integrated into Product Analytics to allow users to select and filter |
| 11445 | +these events in the event picker, similar to how views or actions are handled.</p> |
| 11446 | +<p><strong>Requirements:</strong></p> |
| 11447 | +<ul class="simple"> |
| 11448 | +<li><p>At least one of <code class="docutils literal notranslate"><span class="pre">usr</span></code> , <code class="docutils literal notranslate"><span class="pre">account</span></code> , or <code class="docutils literal notranslate"><span class="pre">session</span></code> must be provided with a valid ID.</p></li> |
| 11449 | +<li><p>The <code class="docutils literal notranslate"><span class="pre">application.id</span></code> must reference a Product Analytics-enabled application.</p></li> |
| 11450 | +</ul> |
| 11451 | +<p><strong>Custom Attributes:</strong> |
| 11452 | +Any additional fields in the payload are flattened and searchable as facets. |
| 11453 | +For example, a payload with <code class="docutils literal notranslate"><span class="pre">{"customer":</span> <span class="pre">{"tier":</span> <span class="pre">"premium"}}</span></code> is searchable with |
| 11454 | +the syntax <code class="docutils literal notranslate"><span class="pre">@customer.tier:premium</span></code> in Datadog.</p> |
| 11455 | +<p>The status codes answered by the HTTP API are:</p> |
| 11456 | +<ul class="simple"> |
| 11457 | +<li><p>202: Accepted: The request has been accepted for processing</p></li> |
| 11458 | +<li><p>400: Bad request (likely an issue in the payload formatting)</p></li> |
| 11459 | +<li><p>401: Unauthorized (likely a missing API Key)</p></li> |
| 11460 | +<li><p>403: Permission issue (likely using an invalid API Key)</p></li> |
| 11461 | +<li><p>408: Request Timeout, request should be retried after some time</p></li> |
| 11462 | +<li><p>413: Payload too large (batch is above 5MB uncompressed)</p></li> |
| 11463 | +<li><p>429: Too Many Requests, request should be retried after some time</p></li> |
| 11464 | +<li><p>500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time</p></li> |
| 11465 | +<li><p>503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time</p></li> |
| 11466 | +</ul> |
| 11467 | +<dl class="field-list simple"> |
| 11468 | +<dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| 11469 | +<dd class="field-odd"><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.product_analytics_server_side_event_item.ProductAnalyticsServerSideEventItem" title="datadog_api_client.v2.model.product_analytics_server_side_event_item.ProductAnalyticsServerSideEventItem"><em>ProductAnalyticsServerSideEventItem</em></a>) – Server-side event to send (JSON format).</p> |
| 11470 | +</dd> |
| 11471 | +<dt class="field-even">Return type<span class="colon">:</span></dt> |
| 11472 | +<dd class="field-even"><p>dict</p> |
| 11473 | +</dd> |
| 11474 | +</dl> |
| 11475 | +</dd></dl> |
| 11476 | +</dd></dl> |
| 11477 | +</section> |
11415 | 11478 | <section id="module-datadog_api_client.v2.api.reference_tables_api"> |
11416 | 11479 | <span id="datadog-api-client-v2-api-reference-tables-api-module"></span><h2 id="module-datadog_api_client.v2.api.reference_tables_api">datadog_api_client.v2.api.reference_tables_api module<a class="headerlink" href="#module-datadog_api_client.v2.api.reference_tables_api" title="Link to this heading">¶</a></h2> |
11417 | 11480 | <dl class="py class"> |
|
![api-clients-generation-pipeline[bot]](https://avatars.githubusercontent.com/u/365230?v=4&size=40){kind=avatar}
0 commit comments