Skip to main content
POST
Sender profile performance

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.

Path Parameters

sid
string
required

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

Required string length: 18
Pattern: ^ub_sp_

Body

application/json

Request body of get_sender_profile_performance.

days
integer

The window in the workspace's days, today included (the drawer shows 30 by default; its 24 hours is 1, today). Either this or from + to, never both. The series covers twice as many days: this window and the one before it, to compare against.

Required range: 1 <= x <= 90
from
string

A custom range instead of days: its first day, YYYY-MM-DD in the workspace's zone, with to.

to
string

The custom range's last day, YYYY-MM-DD, at or after from and at most 90 days after it; the window before it is as long, for the comparison.

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