Retrieves daily, weekly, or monthly statistics of all announcements or a specific group of announcements.
HTTP request
dailyweeklymonthly
GET https://api-{application_id}.sendbird.com/v3/announcement_stats/daily
Parameters
The following table lists the parameters that this action supports.
Parameters
Required
Type
Description
start_date
string
Specifies the start date of the statistics' time range in YYYY-MM-DD format. This string is effective when using the endpoint /announcement_stats/daily. (Default maximum range: 31 days)
end_date
string
Specifies the end date of the statistics' time range in YYYY-MM-DD format. This string is effective when using the endpoint /announcement_stats/daily. (Default maximum range: 31 days)
start_week
string
Specifies the start week of the statistics' time range in YYYY-W# format. This string is effective when using the endpoint /announcement_stats/weekly. (Default maximum range: five weeks)
end_week
string
Specifies the end week of the statistics' time range in YYYY-W# format. This string is effective when using the endpoint /announcement_stats/weekly. (Default maximum range: five weeks)
start_month
string
Specifies the start month of the statistics' time range in YYYY-MM format. This string is effective when using the endpoint /announcement_stats/monthly. (Default maximum range: one month)
end_month
string
Specifies the end month of the statistics' time range in YYYY-MM format. This string is effective when using the endpoint /announcement_stats/monthly. (Default maximum range: one month)
Optional
Type
Description
announcement_group
string
Restricts the search scope to only retrieve announcements in a specified announcement group.
Note: If you want to increase the default maximum range, contact our sales team.
dailyweeklymonthly
// Query string example
?start_date=2020-01-01&end_date=2020-01-15
Response
If successful, this action returns the statistics resources of all announcements or a specific group of announcements within a specified time range in the response body.