GET /featured

Return Featured Resources

Query parameters

products_count integer

Number of Featured Products to Return
articles_count integer

Number of Featured Articles to Return
as_of_date string(DateTime)

Filter Featured Records as of Date

Responses

404

No Featured Resources Found
200

successful operation
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes object
  
  products array[object]
  
  Hide products attribute Show products attribute array[object]
  
  id integer
  
  comparisons array[object]
  
  Hide comparisons attributes Show comparisons attributes array[object]
  
  category_id integer
  
  left_product_id integer
  
  right_product_id integer
  
  comparison_alias string
  
  articles array[object]
  
  Hide articles attribute Show articles attribute array[object]
  
  id integer
401

Authorization information is missing or invalid.
400

Bad Request
500

Server Error

GET /featured

curl \
 -X GET https://api.cosmily.com/api/v1/featured \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "products": [
      {
        "id": 12
      }
    ],
    "comparisons": [
      {
        "left_product_id": 45,
        "right_product_id": 56,
        "category_id": 21,
        "comparison_alias": "clean-cleanser-vs-fancy-cleanser"
      }
    ],
    "articles": [
      {
        "id": 2
      }
    ]
  }
}

Response examples (200)

{
  "data": {
    "articles": [
      {
        "id": 2
      }
    ],
    "products": [
      {
        "id": 12
      }
    ],
    "comparisons": [
      {
        "category_id": 21,
        "left_product_id": 45,
        "comparison_alias": "clean-cleanser-vs-fancy-cleanser",
        "right_product_id": 56
      }
    ]
  }
}