Skip to content

Get usage statistics for a dataset

GET
/datasets/{datasetId}/usage/stats

Returns aggregated usage stats (queries, ingests, cache hit rate) for all tables in the dataset

datasetId
required

Unique identifier for the dataset to retrieve

string

Unique identifier for the dataset to retrieve

startDate

Start of the date range for usage stats (ISO 8601)

string format: date-time

Start of the date range for usage stats (ISO 8601)

endDate

End of the date range for usage stats (ISO 8601)

string format: date-time

End of the date range for usage stats (ISO 8601)

Usage statistics retrieved successfully

object
datasetId
required

ID of the dataset

string
totalOperations
required

Total operations across all tables

number
totalQueries
required

Total query operations

number
totalIngests
required

Total ingestion operations

number
overallCacheHitRate
required

Overall cache hit rate as a decimal (0.0-1.0)

number
lastActivityAt
required

Timestamp of the most recent operation

string format: date-time
nullable
operationsByTable
required

Usage breakdown by table

Array<object>
object
tableId
required

Unique identifier for the table

string
tableName
required

Human-readable name of the table

string
totalOperations
required

Total number of operations on this table

number
totalQueries
required

Number of query operations

number
totalIngests
required

Number of data ingestion operations

number

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean