Skip to main content
POST
Sender profile stats

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of read_sender_profile_stats.

sids
string[]
required

The sender profiles to read (ub_sp_…), 1 to 200. The answer holds one row per sid that names a sender profile of the team, in no fixed order; a sid no row answers to is left out, never an error.

Required array length: 1 - 200 elements

Sender profile sid (ub_sp_…): the unibox sid, the same on the playtables copy.

Required string length: 18
Pattern: ^ub_sp_
from
string
required

The period's start: an ISO 8601 date or moment (a date reads as its midnight UTC). The ledger's done sends and profile visits from here on count under period; the day blocks, the week and the last action do not depend on it.

to
string
required

The period's end: after from, at most 367 days after it (the last 12 months fit in any zone). Exclusive.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required