---
title: "Export usage rows – Superbot API"
canonical_url: "https://superbot.gg/developers/usage/exportUsage"
summary: "The usage rows as a CSV (default), JSON or newline-delimited JSON attachment."
---

> Markdown of https://superbot.gg/developers/usage/exportUsage. Site index: /llms.txt.

# Export usage rows

`GET /v1/usage/export`

The usage rows as a CSV (default), JSON or newline-delimited JSON attachment.

- Operation id: `exportUsage`
- Group: [Usage & spend](https://superbot.gg/developers/usage.md)
- Auth: A caller key holding `usage:read` (`Authorization: Bearer sbc_…` or `x-api-key: sbc_…`), or a signed-in session.
- Scopes: `usage:read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `from` | string (date) | optional | YYYY-MM-DD; default 30 days before `to`. |
| `to` | string (date) | optional | YYYY-MM-DD; default today (UTC). |
| `format` | string | optional | Attachment format; default csv. One of `csv`, `json`, `ndjson`. |
| `tz` | string | optional | IANA zone the days and buckets are read in; default UTC. |
| `key` | string | optional | Only rows from this key id. |
| `lane` | string | optional | Only rows on this lane. |
| `role` | string | optional | Only rows with this agent role. |
| `session` | string | optional | Only rows in this session. |

## Response 200

The rows, as an attachment.

`text/csv`: string.

`application/json`: array of object.

`application/x-ndjson`: string.

## Errors

Every refusal carries `error`, `message`, `doc_url` and `request_id`; the gateway routes answer in the dialect you dialed.

| Status | Codes | When |
| --- | --- | --- |
| 400 | [`invalid_request`](https://superbot.gg/developers#errors-invalid_request) | The request is malformed or a parameter is invalid; `param` names the field. |
| 401 | [`unauthorized`](https://superbot.gg/developers#errors-unauthorized) | The bearer is missing, malformed or unknown. |
| 403 | [`insufficient_scope`](https://superbot.gg/developers#errors-insufficient_scope) | The key lacks a scope (insufficient_scope), is revoked, or may not call this route. |

## Examples

```sh
curl -sS -X GET "https://superbot.gg/v1/usage/export" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"
```

```js
const res = await fetch(`https://superbot.gg/v1/usage/export`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
  },
});
console.log(res.status, await res.json());
```

```python
import os
import requests

res = requests.request(
    "GET",
    "https://superbot.gg/v1/usage/export",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())
```