Posts

Posts are the essence of Cevoid. In the Cevoid platform, a post is a piece of content in the form of an image or video that can be collected, managed, and displayed. Posts are created by customers, influencers, or brand advocates and are a powerful tool for social proof and marketing. On this page, we’ll explore the different post endpoints you can use to manage posts programmatically.

The post model

The post model contains information about your posts, such as their type, media, and tagged products.

Properties

Name
id
Type
string
Description
Unique identifier for the post.
Name
type
Type
string
Description
The type of post. This can be IMAGE or VIDEO.
Name
fromInstagram
Type
string
Description
Determines whether the post was created from an Instagram post.
Name
hideCaption
Type
string
Description
Determines whether the caption should be hidden.
Name
comment
Type
string
Description
The comment for the post.
Name
media
Type
PostMedia
Description
The media for the post.
Name
uploadedBy
Type
PostUser
Description
The user who uploaded the post.
Name
taggedProducts
Type
TaggedProduct[]
Description
The products that were tagged in the post.

PostMedia

Name
location
Type
string
Description
The URL for the media.
Name
filename
Type
string
Description
The filename for the media.
Name
hash
Type
string
Description
Blurhash is a library that creates compressed and blurred representations of images, referred to as hashes, that can serve as temporary placeholders when loading images. To learn more about Blurhash, visit https://blurha.sh/.
Name
aspectRatio
Type
float
Description
The aspect ratio for the media.
Name
hasAudio
Type
boolean
Description
Determines whether the media has audio.
Name
removedAudio
Type
boolean
Description
Determines whether the audio was removed from the media.

PostUser

Name
username
Type
string
Description
The username for the user.
Name
image
Type
PostUserImage
Description
The image for the user.

PostUserImage

Name
location
Type
string
Description
The URL for the image.
Name
hash
Type
string
Description
Blurhash is a library that creates compressed and blurred representations of images, referred to as hashes, that can serve as temporary placeholders when loading images. To learn more about Blurhash, visit https://blurha.sh/.

TaggedProduct

Name
x
Type
string
Description
The x coordinate for the product.
Name
y
Type
string
Description
The y coordinate for the product.
Name
product
Type
Product
Description
The product that was tagged.

GET/v1/galleries/:id/posts

Retrieve posts by gallery

This endpoint allows you to retrieve all posts for a gallery.

Optional attributes

Name
market
Type
string
Description
The market query param can be used to fetch market-specific products. This refers to the markets short id.
Name
skip
Type
integer
Description
Define the number of posts to skip.
Name
limit
Type
integer
Description
Limit the number of posts returned.

Request

GET

/v1/galleries/g-WAz8eIbvDR60rouK/posts

curl -G https://api.cevoid.com/v1/galleries/g-WAz8eIbvDR60rouK/posts \
  -H "x-api-key: {key}"

Response

{
  "count": 16,
  "next": "https://api.cevoid.com/partner/v1/galleries/1234/posts?shop=cevoid.myshopify.com&skip=5",
  "nodes": [
    {
      "type": "IMAGE",
      "fromInstagram": false,
      "hideCaption": false,
      "media": {
        "location": "https://cdn.cevoid.com/images/GGruNRZO0nakgevx8x_kA.jpeg?class=1080",
        "aspectRatio": 1
      }
      //...
    }
  ]
}

GET/v1/products/:id/posts

Retrieve posts by product

This endpoint allows you to retrieve all posts for a gallery.

Optional attributes

Name
market
Type
string
Description
The market query param can be used to fetch market-specific products. This refers to the markets short id.
Name
skip
Type
integer
Description
Define the number of posts to skip.
Name
limit
Type
integer
Description
Limit the number of posts returned.

Request

GET

/v1/products/858494/posts

curl -G https://api.cevoid.com/v1/products/858494/posts \
  -H "x-api-key: {key}"

Response

{
 "count": 16,
  "next": "https://api.cevoid.com/partner/v1/galleries/1234/posts?shop=cevoid.myshopify.com&skip=5",
  "nodes": [
    {
      "type": "IMAGE",
      "fromInstagram": false,
      "hideCaption": false,
      "media": {
        "location": "https://cdn.cevoid.com/images/GGruNRZO0nakgevx8x_kA.jpeg?class=1080",
        "aspectRatio": 1
      }
      //...
    }
  ]
}

GET/v1/members/:id/posts

Retrieve posts by members

This endpoint allows you to retrieve all posts for a specific member.

Optional attributes

Name
market
Type
string
Description
The market query param can be used to fetch market-specific products. This refers to the markets short id.
Name
skip
Type
integer
Description
Define the number of posts to skip.
Name
limit
Type
integer
Description
Limit the number of posts returned.

Request

GET

/v1/members/:id/posts

curl -G https://api.cevoid.com/v1/members/:id/posts \
  -H "x-api-key: {key}"

Response

{
 "count": 16,
  "next": "https://api.cevoid.com/partner/v1/members/1234/posts&skip=5",
  "nodes": [
    {
      "type": "IMAGE",
      "fromInstagram": false,
      "hideCaption": false,
      "media": {
        "location": "https://cdn.cevoid.com/images/GGruNRZO0nakgevx8x_kA.jpeg?class=1080",
        "aspectRatio": 1
      }
      //...
    }
  ]
}

GET/v1/posts

Retrieve posts with label or labels

This endpoint can be used to fetch posts with a specific label or set of labels.

Required attributes

Name
filter
Type
Filter[]
Description
Currently only the label filter is supported.
The ID for a label can be found on the labels page and then clicking the 3 dots icon on a specific label.
The filter array needs to be a stringified JSON object.

Optional attributes

Name
market
Type
string
Description
The market query param can be used to fetch market-specific products. This refers to the markets short id.
Name
skip
Type
integer
Description
Define the number of posts to skip.
Name
limit
Type
integer
Description
Limit the number of posts returned.

Request

GET

/v1/posts

curl -G https://api.cevoid.com/v1/posts?filter=[{ type: "labels", operator: "OR", values: ["62d55201726d36bab74025c0", "629600edfe4d25593655b3d1"]}] \
  -H "x-api-key: {key}"

Response

{
  "count": 16,
  "next": "https://api.cevoid.com/partner/v1/galleries/1234/posts?filter=[{ type: "labels", operator: "AND | OR", values: ["62d55201726d36bab74025c0", "629600edfe4d25593655b3d1"]}]&skip=5",
  "nodes": [
    {
      "type": "IMAGE",
      "fromInstagram": false,
      "hideCaption": false,
      "media": {
        "location": "https://cdn.cevoid.com/images/GGruNRZO0nakgevx8x_kA.jpeg?class=1080",
        "aspectRatio": 1
      }
      //...
    }
  ]
}