Skip to main content
GET
/
signals
/
api
/
v1
/
brand
/
signals
/
List brand signals
curl --request GET \
  --url https://www.closient.com/signals/api/v1/brand/signals/ \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "gtin": "<string>",
      "category": "<string>",
      "body": "<string>",
      "has_voice": true,
      "contact_consent": true,
      "is_flagged": true,
      "created": "2023-11-07T05:31:56Z",
      "batch": "<string>",
      "serial": "<string>",
      "sentiment": "<string>",
      "contact_email": "<string>",
      "flag_reason": "profanity"
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
gtin
string | null

Filter to a single product by GTIN.

​
batch
string | null

Filter to a single batch/lot identifier (GS1 AI 10).

​
serial
string | null

Filter to a single serialized-unit context (serial pool public id).

​
sentiment
string | null

Filter by consumer-declared sentiment code (positive / neutral / negative).

​
category
string | null

Filter by category code (e.g. quality_issue).

​
date_from
string<date> | null

Include signals created on or after this date (ISO YYYY-MM-DD).

​
date_to
string<date> | null

Include signals created on or before this date (ISO YYYY-MM-DD).

​
contact_consent
boolean | null

Filter to signals where the consumer did (true) or did not (false) opt in to contact.

​
page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
​
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

OK

​
data
BrandSignalOut · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

​
pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example:
{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}