Skip to content

Add documentation for credits API endpoint #1767

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

Open
akalia25 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add documentation for credits API endpoint #1767

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ffed58
Update api.mdx
akalia25 May 1, 2026
f618520
update dates
akalia25 May 1, 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
24 changes: 24 additions & 0 deletions docs/analytics/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,27 @@ export END_DATE="2025-12-31"
curl -X GET "https://analytics.sourcegraph.com/api/reports/by-user-client-date?instanceURL=$INSTANCE_URL&startDate=$START_DATE&endDate=$END_DATE" \
-H "Authorization: Bearer $ACCESS_TOKEN"
```

### Credit buckets

The credits API endpoint provides access to credit bucket allocations and consumption for your instance. To retrieve this data, run the following commands:

```sh
export INSTANCE_URL="<INSTANCE_URL>" # e.g. example.sourcegraphcloud.com

curl -X GET "https://analytics.sourcegraph.com/api/credits?instanceURL=$INSTANCE_URL" \
-H "Authorization: Bearer $ACCESS_TOKEN"
```

Optional `startDate` and `endDate` values (formatted as `YYYY-MM-DD`) can be specified to filter buckets by their active period. Both parameters are optional. If neither is specified, all buckets are returned.

Example:

```sh
export INSTANCE_URL="<INSTANCE_URL>" # e.g. example.sourcegraphcloud.com
export START_DATE="2026-05-01"
export END_DATE="2026-12-31"

curl -X GET "https://analytics.sourcegraph.com/api/credits?instanceURL=$INSTANCE_URL&startDate=$START_DATE&endDate=$END_DATE" \
-H "Authorization: Bearer $ACCESS_TOKEN"
```