Skip to main content
GET
Read Studio sales analytics

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

studio_id
string
required
Maximum string length: 256
Pattern: ^stu_

Query Parameters

from
string<date>
required
to
string<date>
required
timezone
string
required
currency
enum<string>
required
Available options:
USD
event_id
string
Maximum string length: 256
Pattern: ^evt_

Response

Studio sales report

daily
object[]
required
Maximum array length: 366
meta
object
required
summary
object
required