📊Reports
Retrieve statistics on audio articles usage programmatically
Get the list of available reports
Available reports
GET https://bottalk.io/api/reports
Fetches a list of available report
{
"result": "ok",
"reports": [
{
"name": "AvgListen",
"title": "Average Listen Report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"d": "Date",
"vg": "Average Listen Length (% of article)",
"project_id": "Project"
}
},
{
"name": "ActiveUsers",
"title": "Playback Started Report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"d": "Date",
"au": "Active Users",
"project_id": "Project"
}
},
{
"name": "UniqueShows",
"title": "Unique Shows Report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"d": "Date",
"imp": "Unique Users",
"project_id": "Project"
}
},
{
"name": "CTR",
"title": "CTR Report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"d": "Date",
"imp": "Impressions",
"au": "Clicks",
"ctr": "CTR",
"project_id": "Project"
}
},
{
"name": "UsersMoreThanTime",
"title": "UsersMoreThanTime Report",
"params": {
"date_start": "today",
"date_end": "tomorrow",
"time": 60
},
"columns": {
"d": "Date",
"nu": "Number of users",
"perc": "Percent of users",
"project_id": "Project"
}
},
{
"name": "UsersMoreThan",
"title": "UsersMoreThan Report",
"params": {
"date_start": "today",
"date_end": "tomorrow",
"percent": 50
},
"columns": {
"d": "Date",
"nu": "Number of users",
"perc": "Percent of users",
"project_id": "Project"
}
},
{
"name": "CohortListenPercent",
"title": "Cohort average listeners report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"p": "Percent of article",
"users": "Number of Users",
"percent": "Percent of Users",
"project_id": "Project"
}
},
{
"name": "PopularArticles",
"title": "Popular Articles Report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"cnt": "Number of listeners",
"title": "Title"
}
},
{
"name": "CohortArticles",
"title": "Cohort Articles Report",
"params": {
"date_start": "today",
"date_end": "tomorrow"
},
"columns": {
"cnt": "Number of listeners",
"title": "Title"
}
}
]
}Get an individual report
Fetch the report data
GET https://bottalk.io/api/reports
Get the data for individual report by name. The parameters vary from one report to another. See available reports section to the the parameters needed for the request.
Last updated