Skip to content

fix (custom-tags): update aggregateByDay example #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
seekuehe merged 2 commits into from
May 21, 2026
Merged

fix (custom-tags): update aggregateByDay example #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0337871
Update aggregateByDay example
seekuehe May 21, 2026
803421e
chore: update OpenAPI JSON files from YAML sources
seekuehe May 21, 2026
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
1 change: 1 addition & 0 deletions api-reference/admin-api/get-custom-tag-usage-analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The response contains a `custom_tag_usage_report` object with the following fiel

Each entry in `usage` includes:
- `custom_tag`: the tag identifier
- `usage_date`: the day the usage was recorded (ISO 8601 datetime). Only returned when `aggregate_by` is `day`
- `breakdown`: character counts split by service type

### Usage breakdown
Expand Down
26 changes: 21 additions & 5 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,15 +341,25 @@
"value": {
"custom_tag_usage_report": {
"aggregate_by": "day",
"start_date": "2026-05-17T00:00:00",
"end_date": "2026-05-18T00:00:00",
"next_page": 2,
"start_date": "2026-05-03T00:00:00",
"end_date": "2026-05-15T00:00:00",
"next_page": null,
"usage": [
{
"custom_tag": "example-custom-tag",
"usage_date": "2026-05-04T00:00:00Z",
"breakdown": {
"total_characters": 380,
"text_translation_characters": 380,
"text_improvement_characters": 0
}
},
{
"custom_tag": "example-custom-tag",
"usage_date": "2026-05-11T00:00:00Z",
"breakdown": {
"total_characters": 190,
"text_translation_characters": 190,
"total_characters": 595,
"text_translation_characters": 595,
"text_improvement_characters": 0
}
}
Expand Down Expand Up @@ -7864,6 +7874,12 @@
"description": "The custom tag identifier.",
"example": "example-custom-tag"
},
"usage_date": {
"type": "string",
"format": "date-time",
"description": "The day the usage was recorded. Only returned when `aggregate_by` is `day`.",
"example": "2026-05-04T00:00:00Z"
},
"breakdown": {
"$ref": "#/components/schemas/CustomTagBreakdown"
}
Expand Down
22 changes: 17 additions & 5 deletions api-reference/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,14 +293,21 @@ paths:
value:
custom_tag_usage_report:
aggregate_by: "day"
start_date: "2026-05-17T00:00:00"
end_date: "2026-05-18T00:00:00"
next_page: 2
start_date: "2026-05-03T00:00:00"
end_date: "2026-05-15T00:00:00"
next_page: null
usage:
- custom_tag: "example-custom-tag"
usage_date: "2026-05-04T00:00:00Z"
breakdown:
total_characters: 380
text_translation_characters: 380
text_improvement_characters: 0
- custom_tag: "example-custom-tag"
usage_date: "2026-05-11T00:00:00Z"
breakdown:
total_characters: 190
text_translation_characters: 190
total_characters: 595
text_translation_characters: 595
text_improvement_characters: 0
400:
description: Bad request. Please check error message and your parameters.
Expand Down Expand Up @@ -5883,6 +5890,11 @@ components:
type: string
description: The custom tag identifier.
example: "example-custom-tag"
usage_date:
type: string
format: date-time
description: The day the usage was recorded. Only returned when `aggregate_by` is `day`.
example: "2026-05-04T00:00:00Z"
breakdown:
$ref: '#/components/schemas/CustomTagBreakdown'
CustomTagBreakdown:
Expand Down