Get a Personal Music Video Rating
Fetch a user’s rating for a music video by using the video’s identifier.
URL
GET https://api.music.apple.com/v1/me/ratings/music-videos/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The unique identifier for the music video. |
Query Parameters
| Name | Type | Description |
|---|---|---|
include Optional | [string] | Additional relationships to include in the fetch. |
l Optional | string | The localization to use, specified by a language tag. The possible values are in the |
extend Optional | [string] | A list of attribute extensions to apply to resources in the response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RatingsResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect |
| 403 | Forbidden Content-Type: application/json | ForbiddenResponse | A response indicating invalid or insufficient authentication. |
| 500 | Internal Server Error Content-Type: application/json | ErrorsResponse | A response indicating an error occurred on the server. |
Discussion
This endpoint requires a music user token. For more information, see User Authentication for MusicKit.
A rating indicates whether a user likes (1) or dislikes (-1) the music video. These are the only two ratings supported.
For a particular music video, the personal ratings for that video’s catalog ID and library ID (if the video is in the library) stay synced.