Organization overview stats
curl --request GET \
--url https://api.creatoraudit.com/v2/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.creatoraudit.com/v2/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.creatoraudit.com/v2/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"current": {
"total_views": 0,
"engagement_rate": 0,
"active_accounts": 0,
"account_videos": 0,
"tracked_videos": 0
},
"previous": {
"total_views": 0,
"engagement_rate": 0,
"active_accounts": 0,
"account_videos": 0,
"tracked_videos": 0
},
"changes": {
"total_views_pct": 0,
"engagement_rate_pct": 0,
"active_accounts_pct": 0,
"account_videos_pct": 0,
"tracked_videos_pct": 0
},
"type": "overview"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}Overview
Organization overview stats
Headline stats for the organization over the selected period.
Returns the current-period snapshot (total views, engagement rate,
active accounts, account-discovered videos, individually tracked
videos), the equivalent previous snapshot, and the percentage
changes between them. Counts with no historical comparison yet are
null (rather than a misleading 0) so callers can tell “no trend”
apart from “a trend of exactly zero”.
GET
/
overview
Organization overview stats
curl --request GET \
--url https://api.creatoraudit.com/v2/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.creatoraudit.com/v2/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.creatoraudit.com/v2/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"current": {
"total_views": 0,
"engagement_rate": 0,
"active_accounts": 0,
"account_videos": 0,
"tracked_videos": 0
},
"previous": {
"total_views": 0,
"engagement_rate": 0,
"active_accounts": 0,
"account_videos": 0,
"tracked_videos": 0
},
"changes": {
"total_views_pct": 0,
"engagement_rate_pct": 0,
"active_accounts_pct": 0,
"account_videos_pct": 0,
"tracked_videos_pct": 0
},
"type": "overview"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "BAD_REQUEST",
"instance": "<string>",
"errors": [
{}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Reporting window for the headline figures.
Available options:
7d, 30d, 90d Response
Successful Response
Show child attributes
Show child attributes