Return song playback history items for a given station.

GET

https://demo.azuracast.com/api/station/{station_id}/history

curl -X GET 'https://demo.azuracast.com/api/station/0/history' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/station/0/history', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/station/0/history',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "sh_id": 0,
    "played_at": 1609480800,
    "duration": 180,
    "playlist": "Top 100",
    "playlist_chain": [
      "Main Rotation",
      "Rock",
      "Rock Hits"
    ],
    "playlist_source": "songs",
    "streamer": "Test DJ",
    "is_request": true,
    "song": {
      "text": "Chet Porter - Aluko River",
      "artist": "Chet Porter",
      "title": "Aluko River",
      "album": "Moving Castle",
      "genre": "Rock",
      "isrc": "US28E1600021",
      "lyrics": "",
      "id": "9f33bbc912c19603e51be8e0987d076b",
      "art": "https://picsum.photos/1200/1200",
      "custom_fields": [
        "custom_field_value"
      ]
    },
    "listeners_start": 94,
    "listeners_end": 105,
    "delta_total": 11,
    "is_visible": true
  }
]

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Parameters

station_idinteger | stringrequiredpath

startstringquery

The start date for records, in PHP-supported date/time format. (https://www.php.net/manual/en/datetime.formats.php)

endstringquery

The end date for records, in PHP-supported date/time format. (https://www.php.net/manual/en/datetime.formats.php)

Response

200OKArray<Api_DetailedSongHistory>

Success

Response fields application/json

Array<Api_DetailedSongHistory>

Show child attributes

sh_idintegerrequired

Song history unique identifier

played_atintegerrequired

UNIX timestamp when playback started.

Example

1609480800

durationintegerrequired

Duration of the song in seconds

Example

playliststring | nullrequired

Indicates the playlist that the song was played from, if available, or empty string if not.

Example

Top 100

playlist_chainArray<string> | nullrequired

Names of the playlist group chain the song was picked through if played from a group

Example

[
  "Main Rotation",
  "Rock",
  "Rock Hits"
]

playlist_sourcePlaylistSources | nullrequired

The source of the playlist that the song was played from, if available.

Show child attributes

One of

PlaylistSourcessongsplaylistsremote_urlrequests

streamerstring | nullrequired

Indicates the current streamer that was connected, if available, or empty string if not.

Example

Test DJ

is_requestbooleanrequired

Indicates whether the song is a listener request.

songApi_HasSongFields & objectrequired

Show child attributes

textstring

The song title, usually “Artist - Title”

Example

Chet Porter - Aluko River

artiststring | null

The song artist.

Example

Chet Porter

titlestring | null

The song title.

Example

Aluko River

albumstring | null

The song album.

Example

Moving Castle

genrestring | null

The song genre.

Example

Rock

isrcstring | null

The International Standard Recording Code (ISRC) of the file.

Example

US28E1600021

lyricsstring | null

Lyrics to the song.

Example

idstring

The song’s 32-character unique identifier hash

Example

9f33bbc912c19603e51be8e0987d076b

artstring

URL to the album artwork (if available).

Example

https://picsum.photos/1200/1200

custom_fieldsArray<string>

listeners_startinteger

Number of listeners when the song playback started.

Example

listeners_endinteger

Number of listeners when song playback ended.

Example

delta_totalinteger

The sum total change of listeners between the song’s start and ending.

Example

is_visibleboolean

Whether the entry is visible on public playlists.

Example

true

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

404Not FoundApi_Error

Record not found.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey