List analytics events
警告Note: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST
https://api.datadoghq.com/api/v2/product-analytics/analytics/listhttps://api.us3.datadoghq.com/api/v2/product-analytics/analytics/listhttps://api.us5.datadoghq.com/api/v2/product-analytics/analytics/listhttps://api.datadoghq.eu/api/v2/product-analytics/analytics/listhttps://api.ap1.datadoghq.com/api/v2/product-analytics/analytics/listhttps://api.ap2.datadoghq.com/api/v2/product-analytics/analytics/listhttps://api.uk1.datadoghq.com/api/v2/product-analytics/analytics/listhttps://api.ddog-gov.com/api/v2/product-analytics/analytics/listhttps://api.us2.ddog-gov.com/api/v2/product-analytics/analytics/list概要
List the individual event records matching an analytics query.
Use columns to choose the attributes returned on each row, sort to order the rows,
and limit to cap how many are returned.
リクエスト
Body Data (required)
フィールド
タイプ
説明
data [required]object
Data object for an analytics list request.
attributes [required]object
Attributes for an analytics list request.
from [required]int64
Start time in epoch milliseconds. Must be less than to.
query [required]object
The analytics list query definition. It selects the events to return with query, then
chooses the columns on each event row, the sort applied to those rows, and a row limit.
Unlike the scalar and timeseries queries, a list query returns raw event rows rather than
aggregates, so it takes no compute or group-by rule.
audience_filtersobject
Audience filter definitions for targeting specific user segments.
accounts[object]
Account audience queries.
name [required]string
Name of this query, referenced in the formula.
querystring
Search query for filtering accounts.
formulastring
Boolean formula combining audience queries by name.
segments[object]
Segment audience queries.
name [required]string
Name of this query, referenced in the formula.
segment_id [required]uuid
UUID of the segment to filter by.
users[object]
User audience queries.
name [required]string
Name of this query, referenced in the formula.
querystring
Search query for filtering users.
columns[string]
Attribute columns to include in each event row.
limitint64
Maximum number of event rows to return.
query [required]<oneOf>
A query definition discriminated by the data_source field.
Use product_analytics for standard event queries, or
product_analytics_occurrence for occurrence-filtered queries.
<data_source=product_analytics>object
A standard Product Analytics event query.
data_source [required]enum
The data source identifier.
Allowed enum values:
product_analyticssearch [required]object
Search parameters for an event query.
querystring
The search query using Datadog search syntax.
<data_source=product_analytics_occurrence>object
A Product Analytics occurrence-filtered query.
data_source [required]enum
The data source identifier for occurrence queries.
Allowed enum values:
product_analytics_occurrencesearch [required]object
Search parameters for an occurrence query.
occurrencesobject
Filter for occurrence-based queries.
metaobject
Additional metadata.
<any-key>string
operator [required]string
Comparison operator (=, >=, <=, >, <).
value [required]string
The occurrence count threshold as a string.
querystring
The search query using Datadog search syntax.
sortobject
The sort applied to the returned event rows.
facetstring
Name of the facet to sort the rows by.
orderenum
The direction rows are sorted in.
Allowed enum values:
asc, descto [required]int64
End time in epoch milliseconds.
type [required]enum
The resource type for analytics list requests.
Allowed enum values:
formula_analytics_extended_list_request{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"audience_filters": {
"accounts": [
{
"name": "",
"query": "string"
}
],
"formula": "u",
"segments": [
{
"name": "",
"segment_id": "00000000-0000-0000-0000-000000000000"
}
],
"users": [
{
"name": "u",
"query": "*"
}
]
},
"columns": [],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
},
"sort": {
"facet": "string",
"order": "string"
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}応答
OK
Response for an analytics list query, containing individual event records.
フィールド
タイプ
説明
data [required]object
Data object for an analytics list response.
attributes [required]object
Attributes of an analytics list response, containing the matching event rows.
records[object]
The event rows, each holding the values of the requested columns.
total_countint64
Total number of records matching the query, before the row limit is applied.
id [required]string
Unique identifier for this response data object.
type [required]enum
The resource type identifier for an analytics list response.
Allowed enum values:
list_responsemetaobject
Metadata for a Product Analytics query response.
request_idstring
Unique identifier of the query.
statusenum
The execution status of a Product Analytics query.
Allowed enum values:
done, running, timeout{
"data": {
"attributes": {
"records": [],
"total_count": "integer"
},
"id": "00000000-0000-0000-0000-000000000000",
"type": "list_response"
},
"meta": {
"request_id": "string",
"status": "string"
}
}Bad Request
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Authorized
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
フィールド
タイプ
説明
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}コード例
List analytics events
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/analytics/list" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"from": 1771232048460,
"query": {
"columns": [
"@view.name"
],
"limit": 100,
"query": {
"data_source": "product_analytics",
"search": {
"query": "@type:view"
}
}
},
"to": 1771836848262
},
"type": "formula_analytics_extended_list_request"
}
}
EOFList analytics events
// List analytics events returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.ProductAnalyticsAnalyticsListRequest{
Data: datadogV2.ProductAnalyticsAnalyticsListRequestData{
Attributes: datadogV2.ProductAnalyticsAnalyticsListRequestAttributes{
From: 1771232048460,
Query: datadogV2.ProductAnalyticsAnalyticsListQuery{
Columns: []string{
"@view.name",
},
Limit: datadog.PtrInt64(100),
Query: datadogV2.ProductAnalyticsBaseQuery{
ProductAnalyticsEventQuery: &datadogV2.ProductAnalyticsEventQuery{
DataSource: datadogV2.PRODUCTANALYTICSEVENTQUERYDATASOURCE_PRODUCT_ANALYTICS,
Search: datadogV2.ProductAnalyticsEventSearch{
Query: datadog.PtrString("@type:view"),
},
}},
},
To: 1771836848262,
},
Type: datadogV2.PRODUCTANALYTICSANALYTICSLISTREQUESTTYPE_FORMULA_ANALYTICS_EXTENDED_LIST_REQUEST,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.QueryProductAnalyticsList", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewProductAnalyticsApi(apiClient)
resp, r, err := api.QueryProductAnalyticsList(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ProductAnalyticsApi.QueryProductAnalyticsList`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `ProductAnalyticsApi.QueryProductAnalyticsList`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"List analytics events
// List analytics events returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ProductAnalyticsApi;
import com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListQuery;
import com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequest;
import com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequestAttributes;
import com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequestData;
import com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListRequestType;
import com.datadog.api.client.v2.model.ProductAnalyticsAnalyticsListResponse;
import com.datadog.api.client.v2.model.ProductAnalyticsBaseQuery;
import com.datadog.api.client.v2.model.ProductAnalyticsEventQuery;
import com.datadog.api.client.v2.model.ProductAnalyticsEventQueryDataSource;
import com.datadog.api.client.v2.model.ProductAnalyticsEventSearch;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.queryProductAnalyticsList", true);
ProductAnalyticsApi apiInstance = new ProductAnalyticsApi(defaultClient);
ProductAnalyticsAnalyticsListRequest body =
new ProductAnalyticsAnalyticsListRequest()
.data(
new ProductAnalyticsAnalyticsListRequestData()
.attributes(
new ProductAnalyticsAnalyticsListRequestAttributes()
.from(1771232048460L)
.query(
new ProductAnalyticsAnalyticsListQuery()
.columns(Collections.singletonList("@view.name"))
.limit(100L)
.query(
new ProductAnalyticsBaseQuery(
new ProductAnalyticsEventQuery()
.dataSource(
ProductAnalyticsEventQueryDataSource
.PRODUCT_ANALYTICS)
.search(
new ProductAnalyticsEventSearch()
.query("@type:view")))))
.to(1771836848262L))
.type(
ProductAnalyticsAnalyticsListRequestType
.FORMULA_ANALYTICS_EXTENDED_LIST_REQUEST));
try {
ProductAnalyticsAnalyticsListResponse result = apiInstance.queryProductAnalyticsList(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ProductAnalyticsApi#queryProductAnalyticsList");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"List analytics events
"""
List analytics events returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.product_analytics_api import ProductAnalyticsApi
from datadog_api_client.v2.model.product_analytics_analytics_list_query import ProductAnalyticsAnalyticsListQuery
from datadog_api_client.v2.model.product_analytics_analytics_list_request import ProductAnalyticsAnalyticsListRequest
from datadog_api_client.v2.model.product_analytics_analytics_list_request_attributes import (
ProductAnalyticsAnalyticsListRequestAttributes,
)
from datadog_api_client.v2.model.product_analytics_analytics_list_request_data import (
ProductAnalyticsAnalyticsListRequestData,
)
from datadog_api_client.v2.model.product_analytics_analytics_list_request_type import (
ProductAnalyticsAnalyticsListRequestType,
)
from datadog_api_client.v2.model.product_analytics_event_query import ProductAnalyticsEventQuery
from datadog_api_client.v2.model.product_analytics_event_query_data_source import ProductAnalyticsEventQueryDataSource
from datadog_api_client.v2.model.product_analytics_event_search import ProductAnalyticsEventSearch
body = ProductAnalyticsAnalyticsListRequest(
data=ProductAnalyticsAnalyticsListRequestData(
attributes=ProductAnalyticsAnalyticsListRequestAttributes(
_from=1771232048460,
query=ProductAnalyticsAnalyticsListQuery(
columns=[
"@view.name",
],
limit=100,
query=ProductAnalyticsEventQuery(
data_source=ProductAnalyticsEventQueryDataSource.PRODUCT_ANALYTICS,
search=ProductAnalyticsEventSearch(
query="@type:view",
),
),
),
to=1771836848262,
),
type=ProductAnalyticsAnalyticsListRequestType.FORMULA_ANALYTICS_EXTENDED_LIST_REQUEST,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["query_product_analytics_list"] = True
with ApiClient(configuration) as api_client:
api_instance = ProductAnalyticsApi(api_client)
response = api_instance.query_product_analytics_list(body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"List analytics events
# List analytics events returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.query_product_analytics_list".to_sym] = true
end
api_instance = DatadogAPIClient::V2::ProductAnalyticsAPI.new
body = DatadogAPIClient::V2::ProductAnalyticsAnalyticsListRequest.new({
data: DatadogAPIClient::V2::ProductAnalyticsAnalyticsListRequestData.new({
attributes: DatadogAPIClient::V2::ProductAnalyticsAnalyticsListRequestAttributes.new({
from: 1771232048460,
query: DatadogAPIClient::V2::ProductAnalyticsAnalyticsListQuery.new({
columns: [
"@view.name",
],
limit: 100,
query: DatadogAPIClient::V2::ProductAnalyticsEventQuery.new({
data_source: DatadogAPIClient::V2::ProductAnalyticsEventQueryDataSource::PRODUCT_ANALYTICS,
search: DatadogAPIClient::V2::ProductAnalyticsEventSearch.new({
query: "@type:view",
}),
}),
}),
to: 1771836848262,
}),
type: DatadogAPIClient::V2::ProductAnalyticsAnalyticsListRequestType::FORMULA_ANALYTICS_EXTENDED_LIST_REQUEST,
}),
})
p api_instance.query_product_analytics_list(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"List analytics events
// List analytics events returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_product_analytics::ProductAnalyticsAPI;
use datadog_api_client::datadogV2::model::ProductAnalyticsAnalyticsListQuery;
use datadog_api_client::datadogV2::model::ProductAnalyticsAnalyticsListRequest;
use datadog_api_client::datadogV2::model::ProductAnalyticsAnalyticsListRequestAttributes;
use datadog_api_client::datadogV2::model::ProductAnalyticsAnalyticsListRequestData;
use datadog_api_client::datadogV2::model::ProductAnalyticsAnalyticsListRequestType;
use datadog_api_client::datadogV2::model::ProductAnalyticsBaseQuery;
use datadog_api_client::datadogV2::model::ProductAnalyticsEventQuery;
use datadog_api_client::datadogV2::model::ProductAnalyticsEventQueryDataSource;
use datadog_api_client::datadogV2::model::ProductAnalyticsEventSearch;
#[tokio::main]
async fn main() {
let body =
ProductAnalyticsAnalyticsListRequest::new(ProductAnalyticsAnalyticsListRequestData::new(
ProductAnalyticsAnalyticsListRequestAttributes::new(
1771232048460,
ProductAnalyticsAnalyticsListQuery::new(
ProductAnalyticsBaseQuery::ProductAnalyticsEventQuery(Box::new(
ProductAnalyticsEventQuery::new(
ProductAnalyticsEventQueryDataSource::PRODUCT_ANALYTICS,
ProductAnalyticsEventSearch::new().query("@type:view".to_string()),
),
)),
)
.columns(vec!["@view.name".to_string()])
.limit(100),
1771836848262,
),
ProductAnalyticsAnalyticsListRequestType::FORMULA_ANALYTICS_EXTENDED_LIST_REQUEST,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.query_product_analytics_list", true);
let api = ProductAnalyticsAPI::with_config(configuration);
let resp = api.query_product_analytics_list(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo runList analytics events
/**
* List analytics events returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations["v2.queryProductAnalyticsList"] = true;
const apiInstance = new v2.ProductAnalyticsApi(configuration);
const params: v2.ProductAnalyticsApiQueryProductAnalyticsListRequest = {
body: {
data: {
attributes: {
from: 1771232048460,
query: {
columns: ["@view.name"],
limit: 100,
query: {
dataSource: "product_analytics",
search: {
query: "@type:view",
},
},
},
to: 1771836848262,
},
type: "formula_analytics_extended_list_request",
},
},
};
apiInstance
.queryProductAnalyticsList(params)
.then((data: v2.ProductAnalyticsAnalyticsListResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"