Skip to main content
GET
Get workspace analytics

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Query Parameters

startDate
string

First day of the range, inclusive, as YYYY-MM-DD in UTC. Omit to start from the first recorded view.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-01"

endDate
string

Last day of the range, inclusive, as YYYY-MM-DD in UTC. Omit to run through today.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-01-01"

timezone
string

IANA time zone used to bucket viewsOverTime into days (default: UTC)

Example:

"America/New_York"

scope
enum<string>

Which videos to aggregate (default: workspace)

Available options:
workspace,
mine
Example:

"workspace"

limit
integer

Top videos per page (default: 20, max: 100)

Required range: 1 <= x <= 100
Example:

20

cursor
string

Opaque cursor for the next page of top videos, from the previous response's pagination.nextCursor

Response

OK

Viewing analytics aggregated across the workspace's videos. Everything except topVideos covers the whole scope; only topVideos is paginated.

endDate
string | null
required

The endDate that was applied, or null for no upper bound

geoBreakdown
object[]
required

Plays by country, up to 100 rows by views

pagination
object
required

Pagination metadata for list responses. Results are sorted by updatedAt descending.

referrerBreakdown
object[]
required

Plays by referring domain, up to 100 rows by views

retention
object[]
required

Watch counts per one-percent slice of the video, ascending

scope
enum<string>
required

workspace: every video shared with the workspace. mine: videos the authenticated user created.

Available options:
workspace,
mine
Example:

"workspace"

startDate
string | null
required

The startDate that was applied, or null for no lower bound

summary
object
required

Headline viewing metrics

timezone
string
required

Time zone used to bucket viewsOverTime

Example:

"UTC"

topVideos
object[]
required

Videos ranked by plays in the range, descending

viewsOverTime
object[]
required

Plays per day, ascending