Create customer audience query

POST/workspaces/{organizationId}/customers/audience-query

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

logicstring

default: "and"

Allowed:andor

predicatesobject[]

default: []

Show properties

Array of object

fieldstringrequired

min length 1

opstringrequired

Allowed:eqneqingteltecontainshas_signal

valuestring | number | boolean | string | number[]required

Show properties

Any of:

string

string

number

number

boolean

boolean

string | number[]

Array of string | number

Any of:

string

string

number

number

limitinteger

min 1 · max 200

Responses

200

Matched customers for dynamic audience filter

totalMatchednumberrequired

merchantsobject[]required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/customers/audience-query' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "logic": "and",
  "predicates": [],
  "limit": 1
}'

const response = await fetch("https://pile.nyc/workspaces/string/customers/audience-query", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"logic\": \"and\",\n  \"predicates\": [],\n  \"limit\": 1\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customers/audience-query",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"logic\": \"and\",\n  \"predicates\": [],\n  \"limit\": 1\n}",
)

Response

{
  "totalMatched": 0,
  "merchants": [
    {
      "property1": null,
      "property2": null
    }
  ]
}