Cosmily API documentation

GET /ingredients/:id_or_alias/endorsed_opinions

GET /ingredients/{id_or_alias}/endorsed_opinions

Returns all endorsed opinions for the ingredient

Path parameters

id_or_alias string Required

ID of the resource to return

Query parameters

endorser string

filter by user_type

Values are brand, expert, or expert_or_brand. Default value is expert_or_brand.
feeling_type string

filter to only positive or negative

Values are positive or negative.

Responses

• 200

successful operation
Hide response attributes Show response attributes object
- data array[object]
  
  Hide data attributes Show data attributes
  
  entry_uuid string(uuid)
  
  opinion_uuid string(uuid)
  
  revision integer
  
  publication string
  
  Values are published, unpublished, or deleted.
  
  created_at string(DateTime)
  
  feeling_type string
  
  Values are positive or negative.
  
  ingredient_id integer
  
  author_user_id integer
  
  active boolean
  
  content object
  
  Hide content attributes Show content attributes
  
  text string
  
  entities object
  
  Hide entities attributes Show entities attributes
  
  hashtags array[object]
  
  Hide hashtags attributes Show hashtags attributes
  
  text string
  
  indices array[integer]
  
  At least 2 but not more than 2 elements.
  
  user_mentions array[object]
  
  Hide user_mentions attributes Show user_mentions attributes
  
  username string
  
  indices array[integer]
  
  At least 2 but not more than 2 elements.
  
  id integer
  
  name string
- links object
  
  Hide links attributes Show links attributes
  
  first string(url)
  
  last string(url)
  
  prev string(url)
  
  next string(url)
• 400

Bad Request
• 401

Authorization information is missing or invalid.
• 404

Ingredient Not Found
• 422

Unprocessable Entity
• 500

Server Error

GET /ingredients/{id_or_alias}/endorsed_opinions

curl \
 -X GET https://api.cosmily.com/api/v1/ingredients/{id_or_alias}/endorsed_opinions \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "entry_uuid": "string",
      "opinion_uuid": "string",
      "revision": 42,
      "publication": "published",
      "created_at": "string",
      "feeling_type": "positive",
      "ingredient_id": 42,
      "author_user_id": 42,
      "active": true,
      "content": {
        "text": "working towards #sustainability with @alex",
        "entities": {
          "hashtags": [
            {
              "text": "sustainability",
              "indices": [
                16,
                31
              ]
            }
          ],
          "user_mentions": [
            {
              "username": "alex",
              "indices": [
                37,
                42
              ],
              "id": 42,
              "name": "string"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  }
}