Cosmily API documentation

GET /compare/shared/:token

GET /compare/shared/{token}

Returns a shared product comparison

Path parameters

token string(uuid) Required

token reference to desired resource

Responses

• 200

successful operation
Hide response attributes Show response attributes object
- data object
  
  Hide data attributes Show data attributes
  
  left_product object
  
  Hide left_product attributes Show left_product attributes
  
  id integer
  
  alias string
  
  right_product object
  
  Hide right_product attributes Show right_product attributes
  
  id integer
  
  alias string
  
  share_token string(uuid)
- links object
  
  Hide links attributes Show links attributes
  
  left_product string(url)
  
  right_product string(url)
  
  left_analysis string(url)
  
  right_analysis string(url)
• 400

Bad Request
• 401

Authorization information is missing or invalid.
• 404

Shared Product Comparision not found
• 422

Unprocessable Entity

GET /compare/shared/{token}

curl \
 -X GET https://api.cosmily.com/api/v1/compare/shared/{token} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "left_product": {
      "id": 42,
      "alias": "string"
    },
    "right_product": {
      "id": 42,
      "alias": "string"
    },
    "share_token": "string"
  },
  "links": {
    "left_product": "string",
    "right_product": "string",
    "left_analysis": "string",
    "right_analysis": "string"
  }
}