Dashboard API

Aggregated statistics and summaries for the dashboard UI. Requires read:dashboard permission.

Get Stats

Get dashboard stats

GET

/v1/dashboard/stats

Returns high-level statistics including total archived emails, total storage used, and failed ingestions in the last 7 days. Requires read:dashboard permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

Dashboard statistics.

Content-Type

application/json

{

  

"totalEmailsArchived": 125000,

  

"totalStorageUsed": 5368709120,

  

"failedIngestionsLast7Days": 2

}

GET

/v1/dashboard/stats

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Get Ingestion History

Get ingestion history

GET

/v1/dashboard/ingestion-history

Returns time-series data of email ingestion counts for the last 30 days. Requires read:dashboard permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

Ingestion history wrapped in a history array.

Content-Type

application/json

{

  

"history": [

  

  

{

  

  

  

"date": "string",

  

  

  

"count": 0

  

  

}

  

]

}

GET

/v1/dashboard/ingestion-history

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Get Ingestion Source Summaries

Get ingestion source summaries

GET

/v1/dashboard/ingestion-sources

Returns a summary list of ingestion sources with their storage usage. Requires read:dashboard permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

List of ingestion source summaries.

Content-Type

application/json

[

  

{

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"name": "Company Google Workspace",

  

  

"provider": "google_workspace",

  

  

"status": "active",

  

  

"storageUsed": 1073741824

  

}

]

GET

/v1/dashboard/ingestion-sources

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Get Recent Syncs

Get recent sync activity

GET

/v1/dashboard/recent-syncs

Returns the most recent sync sessions across all ingestion sources. Requires read:dashboard permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

List of recent sync sessions.

Content-Type

application/json

[

  

{

  

  

"id": "clx1y2z3a0000b4d2",

  

  

"sourceName": "Company Google Workspace",

  

  

"startTime": "string",

  

  

"duration": 4500,

  

  

"emailsProcessed": 120,

  

  

"status": "completed"

  

}

]

GET

/v1/dashboard/recent-syncs

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Get Indexed Email Insights

Get indexed email insights

GET

/v1/dashboard/indexed-insights

Returns top-sender statistics from the search index. Requires read:dashboard permission.

Authorizations

bearerAuth

JWT obtained from POST /v1/auth/login. Pass as Authorization: Bearer <token>.

Type

HTTP (bearer)

or

apiKeyAuth

API key generated via POST /v1/api-keys. Pass as X-API-KEY: <key>.

Type

API Key (header: X-API-KEY)

Responses

Indexed email insights.

Content-Type

application/json

{

  

"topSenders": [

  

  

{

  

  

  

"sender": "[email protected]",

  

  

  

"count": 342

  

  

}

  

]

}

GET

/v1/dashboard/indexed-insights

Playground

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI