List segment filter attributes

List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values.

List segment filter attributes

get

List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values.

The list is profile specific: it includes the profile's custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid attribute, operator and value combinations.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

Responses

200

Success response

application/json

The vocabulary a segment condition can be built from, for one profile.

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes

GET /api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {
      "name": "email",
      "type": "contacts",
      "description": "Contact email address",
      "operators": {
        "ANY_ADDITIONAL_PROPERTY": {
          "operator": "equals",
          "description": "Exact match",
          "input_type": "text",
          "example": "[e-mail]",
          "enum_values": {
            "yes": "yes",
            "no": "no"
          }
        }
      }
    }
  },
  "logic_operators": {
    "AND": "AND",
    "OR": "OR"
  }
}