Substy Developers
Analytics

Get agency creator statistics

Read a performance overview for selected accessible creators over a date range. Choose net or gross earnings; reporting uses the current employee's timezone.

GET/v1/agencies/{agencyId}/analytics/creator-overview

Read a performance overview for selected accessible creators over a date range. Choose net or gross earnings; reporting uses the current employee's timezone.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

Query Parameters

creatorIds?array<string>
Default[]
startDate*string
endDate*string
earningsMode?string
Default"net"

Value in

  • "net"
  • "gross"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/analytics/creator-overview?startDate=string&endDate=string" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "includesEstimatedRevenue": null,    "total": 0,    "totalDelta": 0,    "totalCharts": [      {        "date": "string",        "count": 0      }    ],    "subscriptions": 0,    "subscriptionsDelta": 0,    "subscriptionsCharts": [      {        "date": "string",        "count": 0      }    ],    "posts": 0,    "postsDelta": 0,    "postsCharts": [      {        "date": "string",        "count": 0      }    ],    "messages": 0,    "messagesDelta": 0,    "messagesCharts": [      {        "date": "string",        "count": 0      }    ],    "tips": 0,    "tipsDelta": 0,    "tipsCharts": [      {        "date": "string",        "count": 0      }    ],    "referrals": 0,    "referralsDelta": 0,    "referralsCharts": [      {        "date": "string",        "count": 0      }    ],    "streams": 0,    "streamsDelta": 0,    "streamsCharts": [      {        "date": "string",        "count": 0      }    ],    "totalNewSubs": 0,    "totalNewSubsDelta": 0,    "fansCharts": [      {        "date": "string",        "count": 0      }    ]  },  "meta": {    "requestId": "string"  }}

Get creator performance statistics GET

Read creator performance over a date range with daily, weekly or monthly aggregation. A null creator selects accessible creators; optionally include a creator breakdown. Reporting uses the employee's timezone.

Get creator sales script statistics GET

Read aggregate sales-script performance for a creator over the optional date range. Script statistics require an eligible subscription.