Skip to content
Closed
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.3.0",
"regenerated": "2020-11-18 17:04:49.196168",
"spec_repo_commit": "e3c8008"
"regenerated": "2020-11-19 09:59:51.028039",
"spec_repo_commit": "ee26c54"
},
"v2": {
"apigentools_version": "1.3.0",
"regenerated": "2020-11-18 17:04:58.549741",
"spec_repo_commit": "e3c8008"
"regenerated": "2020-11-19 09:59:59.914277",
"spec_repo_commit": "ee26c54"
}
}
}
273 changes: 273 additions & 0 deletions data/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7303,6 +7303,215 @@ components:
$ref: '#/components/schemas/UsageAnalyzedLogsHour'
type: array
type: object
UsageAttributionAggregates:
description: An array of available aggregates.
items:
$ref: '#/components/schemas/UsageAttributionAggregatesBody'
type: array
UsageAttributionAggregatesBody:
description: The object containing the aggregates.
properties:
agg_type:
description: The aggregate type.
example: sum
type: string
field:
description: The field.
example: custom_timeseries_usage
type: string
value:
description: The value for a given field.
format: double
type: number
type: object
UsageAttributionBody:
description: Usage Summary by tag usage for a given organization.
properties:
month:
description: 'Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM].'
format: date-time
type: string
public_id:
description: The organization public ID.
type: string
tags:
$ref: '#/components/schemas/UsageAttributionTagNames'
updated_at:
description: Shows the the most recent hour in the current months for all
organizations for which all usages were calculated.
type: string
values:
$ref: '#/components/schemas/UsageAttributionValues'
type: object
UsageAttributionMetadata:
description: The object containing document metadata.
properties:
aggregates:
$ref: '#/components/schemas/UsageAttributionAggregates'
pagination:
$ref: '#/components/schemas/UsageAttributionPagination'
type: object
UsageAttributionPagination:
description: The page count for the current pagination.
properties:
limit:
description: Maximum amount of records to be returned.
format: int64
type: integer
offset:
description: Records to be skipped before beginning to return.
format: int64
type: integer
sort_direction:
description: Direction to sort by.
type: string
sort_name:
description: Field to sort by.
type: string
total_number_of_records:
description: Total number of records.
format: int64
type: integer
type: object
UsageAttributionResponse:
description: Response containing the Usage Summary by tag(s).
properties:
metadata:
$ref: '#/components/schemas/UsageAttributionMetadata'
usage:
description: Get Usage Summary by tag(s).
items:
$ref: '#/components/schemas/UsageAttributionBody'
type: array
type: object
UsageAttributionSort:
default: custom_timeseries_usage
description: The field to sort by.
enum:
- api_percentage
- snmp_usage
- lambda_percentage
- apm_host_usage
- api_usage
- container_usage
- custom_timeseries_percentage
- container_percentage
- lambda_usage
- apm_host_percentage
- npm_host_percentage
- browser_percentage
- browser_usage
- infra_host_percentage
- snmp_percentage
- npm_host_usage
- infra_host_usage
- custom_timeseries_usage
type: string
x-enum-varnames:
- API_PERCENTAGE
- SNMP_USAGE
- LAMBDA_PERCENTAGE
- APM_HOST_USAGE
- API_USAGE
- CONTAINER_USAGE
- CUSTOM_TIMESERIES_PERCENTAGE
- CONTAINER_PERCENTAGE
- LAMBDA_USAGE
- APM_HOST_PERCENTAGE
- NPM_HOST_PERCENTAGE
- BROWSER_PERCENTAGE
- BROWSER_USAGE
- INFRA_HOST_PERCENTAGE
- SNMP_PERCENTAGE
- NPM_HOST_USAGE
- INFRA_HOST_USAGE
- CUSTOM_TIMESERIES_USAGE
UsageAttributionTagNames:
additionalProperties:
description: A list of tag values.
items:
description: A given tag in a list.
example: datadog-integrations-lab
type: string
type: array
description: Usage Summary by tag names.
type: object
UsageAttributionValues:
description: Fields in Usage Summary by tag(s).
properties:
api_percentage:
description: The percentage of synthetic API test usage by tag(s).
format: double
type: number
api_usage:
description: The synthetic API test usage by tag(s).
format: double
type: number
apm_host_percentage:
description: The percentage of APM host usage by tag(s).
format: double
type: number
apm_host_usage:
description: The APM host usage by tag(s).
format: double
type: number
browser_percentage:
description: The percentage of synthetic browser test usage by tag(s).
format: double
type: number
browser_usage:
description: The synthetic browser test usage by tag(s).
format: double
type: number
container_percentage:
description: The percentage of container usage by tag(s).
format: double
type: number
container_usage:
description: The container usage by tag(s).
format: double
type: number
custom_timeseries_percentage:
description: The percentage of custom metrics usage by tag(s).
format: double
type: number
custom_timeseries_usage:
description: The custom metrics usage by tag(s).
format: double
type: number
infra_host_percentage:
description: The percentage of infrastructure host usage by tag(s).
format: double
type: number
infra_host_usage:
description: The infrastructure host usage by tag(s).
format: double
type: number
lambda_percentage:
description: The percentage of lambda function usage by tag(s).
format: double
type: number
lambda_usage:
description: The lambda function usage by tag(s).
format: double
type: number
npm_host_percentage:
description: The percentage of network host usage by tag(s).
format: double
type: number
npm_host_usage:
description: The network host usage by tag(s).
format: double
type: number
snmp_percentage:
description: The percentage of network device usage by tag(s).
format: double
type: number
snmp_usage:
description: The network device usage by tag(s).
format: double
type: number
type: object
UsageBillableSummaryBody:
description: Response with properties for each aggregated usage type.
properties:
Expand Down Expand Up @@ -14492,6 +14701,70 @@ paths:
summary: Get hourly usage for analyzed logs
tags:
- Usage Metering
/api/v1/usage/attribution:
get:
description: Get Usage Attribution.
operationId: GetUsageAttribution
parameters:
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
for usage beginning in this month.

Maximum of 15 months ago.'
in: query
name: start_month
required: true
schema:
format: date-time
type: string
- description: The specified field to search results for.
in: query
name: fields
required: true
schema:
type: string
- description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
for usage ending this month.'
in: query
name: end_month
required: false
schema:
format: date-time
type: string
- description: Include usage summaries for each sub-org.
in: query
name: org_id
required: false
schema:
format: int64
type: integer
- description: 'The direction to sort by: `[desc, asc]`.'
in: query
name: sort_direction
required: false
schema:
$ref: '#/components/schemas/UsageSortDirection'
- description: The field to sort by.
in: query
name: sort_name
required: false
schema:
$ref: '#/components/schemas/UsageAttributionSort'
responses:
'200':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/UsageAttributionResponse'
description: OK
'403':
content:
application/json;datetime-format=rfc3339:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
summary: Get Usage Attribution
tags:
- Usage Metering
/api/v1/usage/aws_lambda:
get:
description: Get hourly usage for lambda.
Expand Down
8 changes: 8 additions & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ Class | Method | HTTP request | Description
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_specified_monthly_custom_reports**](docs/UsageMeteringApi.md#get_specified_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports/{report_id} | Get specified monthly custom reports
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_tracing_without_limits**](docs/UsageMeteringApi.md#get_tracing_without_limits) | **GET** /api/v1/usage/tracing-without-limits | Get hourly usage for tracing without limits
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_usage_analyzed_logs**](docs/UsageMeteringApi.md#get_usage_analyzed_logs) | **GET** /api/v1/usage/analyzed_logs | Get hourly usage for analyzed logs
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_usage_attribution**](docs/UsageMeteringApi.md#get_usage_attribution) | **GET** /api/v1/usage/attribution | Get Usage Attribution
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_usage_billable_summary**](docs/UsageMeteringApi.md#get_usage_billable_summary) | **GET** /api/v1/usage/billable-summary | Get billable usage across your multi-org account
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_usage_fargate**](docs/UsageMeteringApi.md#get_usage_fargate) | **GET** /api/v1/usage/fargate | Get hourly usage for Fargate
*DatadogAPIClient::V1::UsageMeteringApi* | [**get_usage_hosts**](docs/UsageMeteringApi.md#get_usage_hosts) | **GET** /api/v1/usage/hosts | Get hourly usage for hosts and containers
Expand Down Expand Up @@ -565,6 +566,13 @@ Class | Method | HTTP request | Description
- [DatadogAPIClient::V1::ToplistWidgetRequest](docs/ToplistWidgetRequest.md)
- [DatadogAPIClient::V1::UsageAnalyzedLogsHour](docs/UsageAnalyzedLogsHour.md)
- [DatadogAPIClient::V1::UsageAnalyzedLogsResponse](docs/UsageAnalyzedLogsResponse.md)
- [DatadogAPIClient::V1::UsageAttributionAggregatesBody](docs/UsageAttributionAggregatesBody.md)
- [DatadogAPIClient::V1::UsageAttributionBody](docs/UsageAttributionBody.md)
- [DatadogAPIClient::V1::UsageAttributionMetadata](docs/UsageAttributionMetadata.md)
- [DatadogAPIClient::V1::UsageAttributionPagination](docs/UsageAttributionPagination.md)
- [DatadogAPIClient::V1::UsageAttributionResponse](docs/UsageAttributionResponse.md)
- [DatadogAPIClient::V1::UsageAttributionSort](docs/UsageAttributionSort.md)
- [DatadogAPIClient::V1::UsageAttributionValues](docs/UsageAttributionValues.md)
- [DatadogAPIClient::V1::UsageBillableSummaryBody](docs/UsageBillableSummaryBody.md)
- [DatadogAPIClient::V1::UsageBillableSummaryHour](docs/UsageBillableSummaryHour.md)
- [DatadogAPIClient::V1::UsageBillableSummaryKeys](docs/UsageBillableSummaryKeys.md)
Expand Down
21 changes: 21 additions & 0 deletions docs/v1/UsageAttributionAggregatesBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# DatadogAPIClient::V1::UsageAttributionAggregatesBody

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agg_type** | **String** | The aggregate type. | [optional]
**field** | **String** | The field. | [optional]
**value** | **Float** | The value for a given field. | [optional]

## Code Sample

```ruby
require 'DatadogAPIClient::V1'

instance = DatadogAPIClient::V1::UsageAttributionAggregatesBody.new(agg_type: sum,
field: custom_timeseries_usage,
value: null)
```


25 changes: 25 additions & 0 deletions docs/v1/UsageAttributionBody.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# DatadogAPIClient::V1::UsageAttributionBody

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. | [optional]
**public_id** | **String** | The organization public ID. | [optional]
**tags** | **Hash<String, Array<String>>** | Usage Summary by tag names. | [optional]
**updated_at** | **String** | Shows the the most recent hour in the current months for all organizations for which all usages were calculated. | [optional]
**values** | [**UsageAttributionValues**](UsageAttributionValues.md) | | [optional]

## Code Sample

```ruby
require 'DatadogAPIClient::V1'

instance = DatadogAPIClient::V1::UsageAttributionBody.new(month: null,
public_id: null,
tags: null,
updated_at: null,
values: null)
```


19 changes: 19 additions & 0 deletions docs/v1/UsageAttributionMetadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DatadogAPIClient::V1::UsageAttributionMetadata

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**aggregates** | [**Array<UsageAttributionAggregatesBody>**](UsageAttributionAggregatesBody.md) | An array of available aggregates. | [optional]
**pagination** | [**UsageAttributionPagination**](UsageAttributionPagination.md) | | [optional]

## Code Sample

```ruby
require 'DatadogAPIClient::V1'

instance = DatadogAPIClient::V1::UsageAttributionMetadata.new(aggregates: null,
pagination: null)
```


Loading