Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions config/_default/menus/api.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5100,6 +5100,22 @@ menu:
unstable:
- v2
order: 4
- name: APM
url: /api/latest/apm/
identifier: apm
generated: true
- name: Get service list
url: '#get-service-list'
identifier: apm-get-service-list
parent: apm
generated: true
params:
versions:
- v2
operationids:
- GetServiceList
unstable: []
order: 1
- name: APM Retention Filters
url: /api/latest/apm-retention-filters/
identifier: apm-retention-filters
Expand Down
3 changes: 3 additions & 0 deletions content/en/api/latest/apm/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: APM
---
10 changes: 5 additions & 5 deletions content/en/api/v1/dashboards/examples.json

Large diffs are not rendered by default.

112 changes: 112 additions & 0 deletions content/en/api/v1/dashboards/request.CreateDashboard_9836563.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
{
"title": "Example-Dashboard",
"description": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "Log Count by Service and Source",
"type": "geomap",
"requests": [
{
"response_format": "scalar",
"queries": [
{
"data_source": "rum",
"name": "query1",
"search": {
"query": "@type:session"
},
"indexes": [
"*"
],
"compute": {
"aggregation": "count"
},
"group_by": []
}
],
"conditional_formats": [
{
"comparator": ">",
"value": 1000,
"palette": "white_on_green"
}
],
"formulas": [
{
"formula": "query1"
}
],
"sort": {
"count": 250,
"order_by": [
{
"type": "formula",
"index": 0,
"order": "desc"
}
]
}
},
{
"response_format": "event_list",
"query": {
"data_source": "logs_stream",
"query_string": "",
"indexes": [],
"storage": "hot"
},
"columns": [
{
"field": "@network.client.geoip.location.latitude",
"width": "auto"
},
{
"field": "@network.client.geoip.location.longitude",
"width": "auto"
},
{
"field": "@network.client.geoip.country.iso_code",
"width": "auto"
},
{
"field": "@network.client.geoip.subdivision.name",
"width": "auto"
}
],
"style": {
"color_by": "status"
},
"text_formats": [
{
"match": {
"type": "is",
"value": "error"
},
"palette": "white_on_red"
}
]
}
],
"style": {
"palette": "hostmap_blues",
"palette_flip": false
},
"view": {
"focus": "NORTH_AMERICA"
}
},
"layout": {
"x": 0,
"y": 0,
"width": 12,
"height": 6
}
}
],
"template_variables": [],
"layout_type": "ordered",
"notify_list": [],
"reflow_type": "fixed",
"tags": []
}
59 changes: 54 additions & 5 deletions content/en/api/v1/dashboards/widgets.json

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions content/en/api/v2/apm/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: APM
headless: true
---
37 changes: 37 additions & 0 deletions content/en/api/v2/apm/examples.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"GetServiceList": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"metadata": [
{
"isTraced": false,
"isUsm": false
}
],
"services": []
},
"id": "string",
"type": "services_list"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> metadata</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">isTraced</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">isUsm</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">services</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Services list resource type. \nAllowed enum values: <code>services_list</code></p><p>default: <code>services_list</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {},
"json": {},
"html": ""
}
}
}
5 changes: 5 additions & 0 deletions data/api/v1/CodeExamples.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@
"suffix": "_3513586382",
"description": "Create a geomap widget using an event_list request"
},
{
"group": "dashboards",
"suffix": "_9836563",
"description": "Create a geomap widget with conditional formats and text formats"
},
{
"group": "dashboards",
"suffix": "",
Expand Down
37 changes: 31 additions & 6 deletions data/api/v1/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3555,9 +3555,10 @@ components:
$ref: '#/components/schemas/WidgetCustomLink'
type: array
requests:
description: 'Array of one request object to display in the widget. The
request must contain a `group-by` tag whose value is a country ISO code.

description: 'Array of request objects to display in the widget. May include
an optional request for the region layer and/or an optional request for
the points layer. Region layer requests must contain a `group-by` tag
whose value is a country ISO code.

See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)

Expand All @@ -3568,7 +3569,7 @@ components:
query: <METRIC_1>{<SCOPE_1>}
items:
$ref: '#/components/schemas/GeomapWidgetRequest'
maxItems: 1
maxItems: 2
minItems: 1
type: array
style:
Expand Down Expand Up @@ -3626,8 +3627,9 @@ components:
focus: WORLD
properties:
focus:
description: The 2-letter ISO code of a country to focus the map on. Or
`WORLD`.
description: The 2-letter ISO code of a country to focus the map on, or
`WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent
(`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
example: WORLD
type: string
required:
Expand All @@ -3646,6 +3648,12 @@ components:
items:
$ref: '#/components/schemas/ListStreamColumn'
type: array
conditional_formats:
description: Threshold (numeric) conditional formatting rules may be used
by a regions layer.
items:
$ref: '#/components/schemas/WidgetConditionalFormat'
type: array
formulas:
description: List of formulas that operate on queries.
items:
Expand All @@ -3671,6 +3679,23 @@ components:
$ref: '#/components/schemas/LogQueryDefinition'
sort:
$ref: '#/components/schemas/WidgetSortBy'
style:
$ref: '#/components/schemas/GeomapWidgetRequestStyle'
text_formats:
description: Text formatting rules may be used by a points layer.
items:
$ref: '#/components/schemas/TableWidgetTextFormatRule'
type: array
type: object
GeomapWidgetRequestStyle:
description: The style to apply to the request for points layer.
example:
color_by: status
properties:
color_by:
description: The category to color the points by.
example: status
type: string
type: object
GraphSnapshot:
description: Object representing a graph snapshot.
Expand Down
67 changes: 67 additions & 0 deletions data/api/v2/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51296,6 +51296,49 @@ components:
$ref: '#/components/schemas/ServiceDefinitionData'
type: array
type: object
ServiceList:
properties:
data:
$ref: '#/components/schemas/ServiceListData'
type: object
ServiceListData:
properties:
attributes:
$ref: '#/components/schemas/ServiceListDataAttributes'
id:
type: string
type:
$ref: '#/components/schemas/ServiceListDataType'
required:
- type
type: object
ServiceListDataAttributes:
properties:
metadata:
items:
$ref: '#/components/schemas/ServiceListDataAttributesMetadataItems'
type: array
services:
items:
type: string
type: array
type: object
ServiceListDataAttributesMetadataItems:
properties:
isTraced:
type: boolean
isUsm:
type: boolean
type: object
ServiceListDataType:
default: services_list
description: Services list resource type.
enum:
- services_list
example: services_list
type: string
x-enum-varnames:
- SERVICES_LIST
ServiceNowBasicAuth:
description: The definition of the `ServiceNowBasicAuth` object.
properties:
Expand Down Expand Up @@ -61560,6 +61603,27 @@ paths:
permissions:
- apm_retention_filter_write
- apm_pipelines_write
/api/v2/apm/services:
get:
operationId: GetServiceList
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceList'
description: OK
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- apm_read
summary: Get service list
tags:
- APM
x-menu-order: 1
/api/v2/app-builder/apps:
delete:
description: Delete multiple apps in a single request from a list of app IDs.
Expand Down Expand Up @@ -89319,6 +89383,9 @@ servers:
tags:
- description: Configure your API endpoints through the Datadog API.
name: API Management
- description: Observe, troubleshoot, and improve cloud-scale applications with all
telemetry in context
name: APM
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
for your organization. You need an API and application key with Admin rights to
interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)
Expand Down
3 changes: 3 additions & 0 deletions data/api/v2/translate_actions.json
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,9 @@
"request_description": "The updated definition of the retention filter.",
"request_schema_description": "The body of the retention filter to be updated."
},
"GetServiceList": {
"summary": "Get service list"
},
"DeleteApps": {
"description": "Delete multiple apps in a single request from a list of app IDs. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).",
"summary": "Delete Multiple Apps",
Expand Down
4 changes: 4 additions & 0 deletions data/api/v2/translate_tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"name": "API Management",
"description": "Configure your API endpoints through the Datadog API."
},
"apm": {
"name": "APM",
"description": "Observe, troubleshoot, and improve cloud-scale applications with all telemetry in context"
},
"apm-retention-filters": {
"name": "APM Retention Filters",
"description": "Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters) for your organization. You need an API and application key with Admin rights to interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters) on the Trace Retention page for more information."
Expand Down
Loading