GET ​/api​/v3​/account​/me​/recommended_stations

Returns the recommended station list for the logged in user.

Request

Example Request

{
  "auth_token": "770a077e6f739c9aaea85241652b0ff558dd8ced5cda4fc57c6fc1901a941a1",
  "refresh": true,
  "page": 1,
  "per_page": 30
}

Example Parameters

  • auth_token: The user's authentication token, retreived by logging in.

    • Required: yes
    • Type: string
    • Example: 770a077e6f739c9aaea85241652b0ff558dd8ced5cda4fc57c6fc1901a941a1
  • refresh: Trigger a forced refresh of recommendations. Useful if the user just changed location or genres and a client needs to get updated results.

    • Required: no
    • Type: boolean
  • page: The page number (starting at 1)

    • Required: no
    • Type: integer
    • Example: 1
  • per_page: The number of records returned in each page. Defaults to 30

    • Required: no
    • Type: integer
    • Example: 30

Response

Example Response

{
  "recommended_stations": [
    {
      "id": 1,
      "title": "Houston Radio",
      "subtitle": "Featuring artists like Foo, Bar, and Baz",
      "banner_url": "http://example.com/banner",
      "station_type": "dynamic",
      "photos": [
        {
          "id": 1,
          "small_hq": {
            "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/preview_retina_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
          }
        }
      ]
    }
  ],
  "meta": {
    "status": {
    },
    "last_refreshed_at": {
    },
    "page": {
    },
    "per_page": {
    },
    "total_pages": {
    },
    "records": {
    }
  }
}

Response Parameters

  • recommended_stations:

    • Required: no
    • Type: array
    • Items

      • Required: no
      • id: The id of the station
        • Required: yes
        • Type: integer
        • Example: 1
      • title: The title of the station
        • Required: yes
        • Type: string
        • Example: Houston Radio
      • subtitle: The subtitle of the station
        • Required: yes
        • Type:
          • null
          • string
        • Example: Featuring artists like Foo, Bar, and Baz
      • banner_url: The url of the station banner
        • Required: yes
        • Type:
          • null
          • string
        • Example: http://example.com/banner
      • station_type: The type of station
        • Required: yes
        • Type: string
        • Example: dynamic
      • photos: A list of photos for the station based on the upcoming artists playing at this station.

        • Required: yes
        • Type: array
        • Items

          • Required: no
          • id: The unique ID of the photo
          • __small_hq__: A retina preview artist photo

  • meta:

    • Required: no
    • status: Indicates the status of the recommendation job that is running in the background for this user. Possible values are null, "queued", "running", "failed"
      • Required: no
      • Type:
        • String
      • Example: running
    • lastrefreshedat: The timestamp when the recommendations were last refreshed in ISO8601 UTC format.
      • Required: no
      • Type:
        • String
      • Example: 2014-09-04 18:46:29 UTC
    • page: The page requested.
      • Required: no
      • Type: Number
      • Example: 1
    • per_page: The number of records returned in each page.
      • Required: no
      • Type: Number
      • Example: 20
    • total_pages: The total number of pages available to request.
      • Required: no
      • Type: Number
      • Example: 4
    • records: The total number of records.
      • Required: no
      • Type: Number
      • Example: 75

Response Codes

Successful Response Codes

  • 200:

Failure Response Codes