User History

Endpoint

GET https://api.stats.skylerx.ir/v1/users/{identifier}/history

Input

The identifier can be either the UserId or Slug. You can get this id using the users profile url.

Example: https://stats.skyerlx.ir/ba

In this case ba is the identifier.

{
  identifier: string;
}

Query Params

Prop	Type	Default
`include?`	`"artists" \| "tracks"`	-

The include field is comma separated meaning you'd need something like ?include=artists,genres

Output

Streaming stats

Prop	Type	Default
`peak_hour`	`number`	-
`streams`	`number`	-
`tracks`	`number`	-
`unique_artists`	`number`	-
`hours`	`number`	-
`minutes`	`number`	-

Personalized Messages

Prop	Type	Default
`personalized_messages`	`Array<string>`	-

{
    "personalized_messages": ['...']
}

Heatmap

Prop	Type	Default
`dailyCounts`	`Array<{ date: string, count: number }>`	-
`maxCount`	`number`	-
`years`	`Array<number>`	-

Listening Sessions

Prop	Type	Default
`stopped_at`	`Date`	-
`started_at`	`Date`	-
`duration`	`number`	-
`total_sessions`	`number`	-

Insights for listening session

{
    "insights": {
        "tracks": {
            "total": number,
            "unique": number
        },
        "artists": {
            "total": number,
            "unique": number
        }
    }
}

Hourly Activity

Prop	Type	Default
`hourly_activity`	`Array<{ hour: number, count: number }>`	-

User History

On this page