List highlights
GET {{baseUrl}}/{{version}}/highlights?start_date=2022-05-01&name=John&tag_id=&category=Defensive&sort_name=&sorting=Desc&limit=10&video_id=200&with_video_only=1&page=1&end_date=2022-06-10&team_id=100
This endpoint enables you to retrieve a list of highlights.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | required | |
name | string | nullable |
The name of the tag |
| tag_id | null | | nullable | integer | Tag UID |
| category | string | | nullable | string | in: defensive, offensive
The Tag Category |
| sort_name | null | | nullable | string | in: tag_name, team_name | default: it sorts by created_at |
| sorting | string | | nullable | string | in: desc, asc | default: desc |
| limit | number | | nullable | integer | min: 1 | max: 100 | default: desc |
| video_id | number | | nullable | integer | Video UID |
| with_video_only | number | | nullable | boolean| in:1,0 | default:0
Return only highlights with video |
| page | number | | nullable | integer | default: 1 |
| end_date | string | | required | date | format: yyy-mm-dd |
| team_id | number | | nullable | integer |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | A valid JWT token |
RESPONSES
status: OK
{"error":false,"code":200,"message":"List of highlights","highlights":{"current_page":1,"data":[{"high_id":16,"video_id":19,"tag_id":10,"team_id":217,"high_video_url":"/videolibrary/team_217/highlights/game/high_62493e8a56711.mp4","deleted_at":null,"created_at":"2022-04-03T06:28:24.000000Z","updated_at":"2022-04-03T06:28:30.000000Z","tag_name":"Block","tag_abbreviation":"BLK","tag_category":"defensive","team_name":"Lunas","team_avatar":"https://files.teamsportz.app/teams/217_1646137024.jpg","video_name":"Poor offload in the tackle leads to turnover.","video_type":"game"},{"high_id":22,"video_id":15,"tag_id":10,"team_id":217,"high_video_url":"/videolibrary/team_217/highlights/game/high_624bfd886e710.mp4","deleted_at":null,"created_at":"2022-04-05T08:27:49.000000Z","updated_at":"2022-04-05T08:28:04.000000Z","tag_name":"Block","tag_abbreviation":"BLK","tag_category":"defensive","team_name":"Lunas","team_avatar":"https://files.teamsportz.app/teams/217_1646137024.jpg","video_name":"Pre season match first half","video_type":"game"},{"high_id":23,"video_id":145,"tag_id":10,"team_id":217,"high_video_url":"/videolibrary/team_217/highlights/game/high_624ca5c644f61.mp4","deleted_at":null,"created_at":"2022-04-05T20:25:40.000000Z","updated_at":"2022-04-05T20:25:49.000000Z","tag_name":"Block","tag_abbreviation":"BLK","tag_category":"defensive","team_name":"Lunas","team_avatar":"https://files.teamsportz.app/teams/217_1646137024.jpg","video_name":"Pre season match first half","video_type":"game"}],"first_page_url":"https://api.teamsportz.pro/v1/highlights?page=1","from":1,"last_page":1,"last_page_url":"https://api.teamsportz.pro/v1/highlights?page=1","links":[{"url":null,"label":"pagination.previous","active":false},{"url":"https://api.teamsportz.pro/v1/highlights?page=1","label":"1","active":true},{"url":null,"label":"pagination.next","active":false}],"next_page_url":null,"path":"https://api.teamsportz.pro/v1/highlights","per_page":"20","prev_page_url":null,"to":3,"total":3}}