Get posts tagged with a specific product

GET

products

{id}

posts

curl --request GET \
  --url https://api.cevoid.com/v1/products/{id}/posts \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.cevoid.com/v1/products/{id}/posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cevoid.com/v1/products/{id}/posts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cevoid.com/v1/products/{id}/posts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cevoid.com/v1/products/{id}/posts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "next": "<string>",
  "nodes": [
    {
      "id": "post_abc123def456",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "media": {
        "location": "https://cdn.cevoid.com/media/posts/abc123.jpg",
        "hash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
        "filename": "summer-vacation-photo.jpg"
      },
      "taggedProducts": [
        {
          "x": 0.35,
          "y": 0.65,
          "product": {
            "id": "prod_abc123",
            "title": "Wireless Bluetooth Headphones",
            "price": {
              "price": 99.99,
              "currency": "USD",
              "salePrice": 79.99
            },
            "category": "Electronics > Audio > Headphones",
            "media": {
              "location": "https://cdn.cevoid.com/media/products/headphones-main.jpg",
              "hash": "a1b2c3d4e5f6g7h8i9j0",
              "filename": "wireless-headphones-product-image.jpg"
            },
            "handle": "wireless-bluetooth-headphones",
            "url": "https://mystore.com/products/wireless-bluetooth-headphones",
            "developmentUrl": "https://dev.mystore.com/products/wireless-bluetooth-headphones",
            "sku": "WH-1000XM5-BLK",
            "mpn": "693903",
            "gtin": "7391998206837"
          }
        }
      ],
      "origin": {
        "type": "instagram"
      },
      "alt": "Woman wearing sunglasses standing next to a red convertible car on a sunny beach",
      "videoCaptions": "Welcome to our summer collection! Check out these amazing sunglasses perfect for beach days.",
      "videoDescription": "Video shows a woman modeling sunglasses while walking along a sandy beach with palm trees in the background",
      "instagramUrl": "https://www.instagram.com/p/ABC123DEF456/",
      "type": "IMAGE",
      "fromInstagram": true,
      "addedByCompany": false,
      "instagramDate": "2024-01-10T14:22:00.000Z",
      "comment": "Perfect day at the beach! ☀️ #SummerVibes #BeachLife #Sunglasses",
      "hideCaption": false,
      "uploadedBy": {
        "username": "john_doe_photography",
        "email": "sarah@example.com",
        "image": {
          "hash": "sha256:b2c3d4e5f6a7...",
          "filename": "profile-pic.jpg",
          "location": "https://cdn.cevoid.com/profiles/user123/avatar.jpg"
        }
      }
    }
  ]
}

"<string>"

"No valid API key provided"

"Something went wrong"

Authorizations

x-api-key

string

header

required

Path Parameters

string

required

Product identifier, interpreted according to the id_type query parameter: the product's external ID (default), or a manufacturer part number when id_type=mpn

Example:

"product123"

Query Parameters

limit

number

default:25

Max value for limit is 25

Required range: 1 <= x <= 25

Example:

10

skip

number | null

default:0

Number of items to skip

Required range: x >= 0

Example:

0

market

string

Market ID or shortId for localized content

Example:

"us"

filter

string

JSON string array of filter criteria. See Core Concepts → Filtering for detailed filter structure and supported operators.

Example:

"[{\"type\":\"label\",\"operator\":\"OR\",\"values\":[\"507f1f77bcf86cd799439011\",\"507f191e810c19729de860ea\"]}]"

id_type

enum<string>

How the {id} path parameter resolves to products. 'external_id' (default) matches the single product with that id from your platform. 'mpn' matches every product carrying that manufacturer part number and returns posts tagged with any of them, including color- and product-level tags on grouped products. An mpn matching more than 500 products returns 400.

Available options:

external_id,

mpn

Example:

"mpn"

Response

Successful response

count

number

required

Total number of items

string | null

required

URL for next page

nodes

object[]

required

Show child attributes

Get posts tagged with a specific product

curl --request GET \
  --url https://api.cevoid.com/v1/products/{id}/posts \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.cevoid.com/v1/products/{id}/posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cevoid.com/v1/products/{id}/posts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cevoid.com/v1/products/{id}/posts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cevoid.com/v1/products/{id}/posts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "count": 123,
  "next": "<string>",
  "nodes": [
    {
      "id": "post_abc123def456",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "media": {
        "location": "https://cdn.cevoid.com/media/posts/abc123.jpg",
        "hash": "LEHV6nWB2yk8pyo0adR*.7kCMdnj",
        "filename": "summer-vacation-photo.jpg"
      },
      "taggedProducts": [
        {
          "x": 0.35,
          "y": 0.65,
          "product": {
            "id": "prod_abc123",
            "title": "Wireless Bluetooth Headphones",
            "price": {
              "price": 99.99,
              "currency": "USD",
              "salePrice": 79.99
            },
            "category": "Electronics > Audio > Headphones",
            "media": {
              "location": "https://cdn.cevoid.com/media/products/headphones-main.jpg",
              "hash": "a1b2c3d4e5f6g7h8i9j0",
              "filename": "wireless-headphones-product-image.jpg"
            },
            "handle": "wireless-bluetooth-headphones",
            "url": "https://mystore.com/products/wireless-bluetooth-headphones",
            "developmentUrl": "https://dev.mystore.com/products/wireless-bluetooth-headphones",
            "sku": "WH-1000XM5-BLK",
            "mpn": "693903",
            "gtin": "7391998206837"
          }
        }
      ],
      "origin": {
        "type": "instagram"
      },
      "alt": "Woman wearing sunglasses standing next to a red convertible car on a sunny beach",
      "videoCaptions": "Welcome to our summer collection! Check out these amazing sunglasses perfect for beach days.",
      "videoDescription": "Video shows a woman modeling sunglasses while walking along a sandy beach with palm trees in the background",
      "instagramUrl": "https://www.instagram.com/p/ABC123DEF456/",
      "type": "IMAGE",
      "fromInstagram": true,
      "addedByCompany": false,
      "instagramDate": "2024-01-10T14:22:00.000Z",
      "comment": "Perfect day at the beach! ☀️ #SummerVibes #BeachLife #Sunglasses",
      "hideCaption": false,
      "uploadedBy": {
        "username": "john_doe_photography",
        "email": "sarah@example.com",
        "image": {
          "hash": "sha256:b2c3d4e5f6a7...",
          "filename": "profile-pic.jpg",
          "location": "https://cdn.cevoid.com/profiles/user123/avatar.jpg"
        }
      }
    }
  ]
}

"<string>"

"No valid API key provided"

"Something went wrong"

Introduction

Core Concepts

Endpoints

Get posts tagged with a specific product

Authorizations

Path Parameters

Query Parameters

Response