Skip to content

Commit 2832258

Browse files
authored
docs: mention request id header (#7088)
1 parent e5aa9bd commit 2832258

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

packages/web/docs/src/content/api-reference/usage-reports.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,14 @@ them in batches (as a single report, when a buffer is full or every few seconds)
1313

1414
> It's recommended to send a report for more than 1 operation. The maximum payload size is 15 MB.
1515
16-
| Name | Value |
17-
| -------------------- | -------------------------------------------------------------------------------------------------------------------------- |
18-
| Endpoint | `https://app.graphql-hive.com/usage/<ORGANIZATION>/<PROJECT>/<TARGET>` or `https://app.graphql-hive.com/usage/<TARGET_ID>` |
19-
| Authorization Header | `Authorization: Bearer <ACCESS_TOKEN>` |
20-
| API version Header | `X-Usage-API-Version: 2` |
21-
| Method | `POST` |
22-
| Content-Type Header | `Content-Type: application/json` |
16+
| Name | Value |
17+
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
18+
| Endpoint | `https://app.graphql-hive.com/usage/<ORGANIZATION>/<PROJECT>/<TARGET>` or `https://app.graphql-hive.com/usage/<TARGET_ID>` |
19+
| Authorization Header | `Authorization: Bearer <ACCESS_TOKEN>` |
20+
| API version Header | `X-Usage-API-Version: 2` |
21+
| Request ID Header | `X-Request-Id: <UUIDv4>` (We recommend sending a unique request id on logging it on your end, so we can help you debugging failing requests.) |
22+
| Method | `POST` |
23+
| Content-Type Header | `Content-Type: application/json` |
2324

2425
You can either use the slug or id of the target for the usage reporting endpoint. Be aware that
2526
using the target ID is more resilient in case you rename either your organization, project or

0 commit comments

Comments
 (0)