GET ​/api​/v3​/recommended_artists

Returns the recommended artist list for the logged in user.

Request

Example Request

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

Example Parameters

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

    • Required: no
    • Type: string
    • Example: 770a077e6f739c9aaea85241652b0ff558dd8ced5cda4fc57c6fc1901a941a1
  • 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_artists": [
    {
      "id": 1,
      "name": "The Rolling Stones",
      "slug": "rolling-stones",
      "facebook_url": "http://www.facebook.com/rollingstones",
      "location": "Houston, TX",
      "genres": [
        "Rock"
      ],
      "official_station_id": {
      },
      "url": "http://www.therollingstones.com/",
      "twitter_handle": "rollingstones",
      "you_follow": true,
      "media": {
        "photos": [
          {
            "id": 1,
            "small": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/preview_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            },
            "small_hq": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/preview_retina_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            },
            "medium": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/small_wide_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            },
            "medium_hq": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/small_wide_retina_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            },
            "large": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/fullscreen_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            },
            "large_hq": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/fullscreen_retina_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            },
            "cover_980": {
              "url": "https://deliradio.s3.amazonaws.com/uploads/picture/band/2/1/cover_980_673e03ba-cc71-4f61-b7ee-f99faaf4ff3a.png"
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "status": {
    },
    "last_refreshed_at": {
    },
    "page": {
    },
    "per_page": {
    },
    "total_pages": {
    },
    "records": {
    }
  }
}

Response Parameters

  • recommended_artists:

    • Required: no
    • Type: array
    • Items

      • Required: no
      • id: The unique ID of the artist
        • Required: yes
        • Type: integer
        • Example: 1
      • name: The name of the artist
        • Required: yes
        • Type: string
        • Example: The Rolling Stones
      • slug: The unique slug for an artist
        • Required: yes
        • Type: string
        • Example: rolling-stones
      • facebook_url: The facebook url for the artist
        • Required: yes
        • Type:
          • null
          • string
        • Example: http://www.facebook.com/rollingstones
      • location: The location of the artist
        • Required: yes
        • Type: string
        • Example: Houston, TX
      • genres: Genres associated with the artist

        • Required: yes
        • Type: array
        • Items

          • Required: no
          • Type: string
          • Example: Rock
      • officialstationid: The official station id for this artist

        • Required: no
        • Type: Number
        • Example: 12412
      • url: The URL to the artists website

        • Required: yes
        • Type:
          • null
          • string
        • Format: uri
        • Example: http://www.therollingstones.com/
      • twitter_handle: The twitter handle of the band

        • Required: yes
        • Type:
          • null
          • string
        • Example: rollingstones
      • you_follow: Indicates whether the current user follows this artist.

        • Required: yes
        • Type: boolean
        • Example: true
      • media:

        • Required: yes
        • photos: Photos of the artist

          • Required: yes
          • Type: array
          • Items

  • 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