Chapters
Method: POST
URL: https://www.wellcomemat.com/api/analytics/chapters.php
Notes:
- Both total clicks and click data separated by time are returned.
Parameters
Key | Type | Description |
---|---|---|
key | text | {{key}} |
secret | text | {{secret}} |
start_date | text | Required [YYYY-MM-DD hh:mm:ss] |
end_date | text | Required [YYYY-MM-DD hh:mm:ss] |
shared | text | If request Rolled-up Reporting [“true”,“false”] |
hash | text | Focuses view query on the given Media Hash |
filter | text | Custom filter can be created (“vv.media_id = 214122”) |
debug | text | [“true”,“false”] |
Response
type AnalyticsChaptersResponse = {
success: 0 | 1;
data: {
total_clicks: number;
by_time: {
time: number; // seconds
title: string;
clicks: number;
}[];
};
google_chart: string; // (with escaped characters)
error: string;
warnings: string;
};