Skip to content

analytics: replace access token creation with management UI #1299

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
merged 1 commit into from
Jul 31, 2025
Merged

analytics: replace access token creation with management UI #1299

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
97 changes: 1 addition & 96 deletions docs/analytics/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,102 +6,7 @@ The Sourcegraph Analytics API is an API that provides programmatic access to you

For Sourcegraph Analytics, you can generate an access token for programmatic access. Tokens are long-lived with an optional expiry and have the same permissions to access instance data as the user who created them.

### Getting Started

Access tokens are created using the `cas` cookie for authentication to the token creation endpoint. Access tokens are longer lived than the `cas` cookie making them more suitable for programmatic access to the Sourcegraph Analytics API.

- Sign in to [Sourcegraph Analytics](https://analytics.sourcegraph.com).
- Retrieve your session cookie, `cas`, from your browser's developer tools.

![Sourcegraph Analytics session cookie](https://storage.googleapis.com/sourcegraph-assets/Docs/analytics-cookie.png)

- Export the cookie as an environment variable to use in the following commands:

```sh
export CAS_COOKIE="<CAS_COOKIE_VALUE>"
```

#### Token creation

Create the token by running the following command:

```sh
curl -X POST https://analytics.sourcegraph.com/api/service-access-tokens \
-H "Content-Type: application/json" \
-H "Cookie: cas=$CAS_COOKIE" \
-d '{}'

# Optionally include displayName, expiresAt, or both in the request body.
# If expiresAt is not provided, the token will never expire and must be revoked manually.
# -d '{"displayName": "My Analytics Token", "expiresAt": "2025-12-31T23:59:59Z"}'
```

The response will include the token ID, secret, creation date, and, if provided, display name and expiration date. For example:

```json
{
"id": "4cf96e80-d5f3-4af0-a28d-3c70ba97abb4",
"displayName": "My Analytics Token",
"secret": "sams_at_abcdefghijk",
"createdAt": "2025-05-28T12:00:00Z",
"expiresAt": "2025-12-31T23:59:59Z"
}
```

#### Token listing

List the tokens by running the following command:

```sh
curl -X GET https://analytics.sourcegraph.com/api/service-access-tokens \
-H "Cookie: cas=$CAS_COOKIE"
```

Each token in the response will include the token ID, creation date, a boolean indicating if the token has expired, and display name and expiration date if provided. For example:

```json
{
"tokens": [
{
"id": "5a140b00-3a79-497d-bcfb-c1d2e3d8c747",
"displayName": "My Analytics Token",
"createdAt": "2025-05-27T12:00:00Z",
"expiresAt": "2025-05-27T13:00:00Z",
"isExpired": true
},
{
"id": "eaf8a6f1-1302-43f6-a9ad-f9862d75e959",
"createdAt": "2025-05-28T12:30:00Z",
"expiresAt": "2025-05-28T13:30:00Z",
"isExpired": true
},
{
"id": "d7df6636-99d0-4266-9f32-a2fb7ccbfcd5",
"displayName": "My Analytics Token 2",
"createdAt": "2025-05-28T15:00:00Z",
"isExpired": false
},
{
"id": "8ea63000-a164-44ca-8834-bb71e9b788fb",
"createdAt": "2025-05-28T15:30:00Z",
"isExpired": false
}
]
}
```

#### Token revocation

Revoke a token by running the following commands:

```sh
export TOKEN_ID="<TOKEN_ID>"

curl -X DELETE https://analytics.sourcegraph.com/api/service-access-tokens/$TOKEN_ID \
-H "Cookie: cas=$CAS_COOKIE"
```

<Callout type="note">The revocation request does not produce output. To verify that a token has been revoked, list the tokens and verify that `isExpired` is `true`.</Callout>
To get started, visit the [Sourcegraph Analytics access tokens management page](http://analytics.sourcegraph.com/access-tokens). From here, you can create, view, and revoke access tokens for your Sourcegraph Account.

## API reference

Expand Down