Get the user's replay data

Fetch the user’s replay data for the latest eligible year.

URL

GET https://api.music.apple.com/v1/me/music-summaries

Query Parameters

Name	Type	Description
`extend` Optional	[string]	A list of attribute extensions applied to resources in the response.
`filter[year]` Required	[string]	A filter applied to the request. The value is always `latest`.
`include` Optional	[string]	A list of relationship names to include for resouces in the response.
`l` Optional	string	The localization specified by a language tag. The possible values are in the `supportedLanguageTags` array belonging to the `Storefront` object specified by the storefront. Otherwise, the storefront’s `defaultLanguageTag` is used.
`views` Optional	[string]	The views to activate for the music summaries resource.

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`MusicSummariesResponse`	The request was successful.
401	Unauthorized Content-Type: application/json	`UnauthorizedResponse`	A response indicating an incorrect `Authorization` header.
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

A successful HTTP request returns music summaries for the most recent year that the user has enough listening history. If unsuccessful, the HTTP status code indicates the error, and the details are in the errors array. For more information, see Handling Requests and Responses.