Discover available filter attributes

GET

/v1/schema/fields

const url = 'https://dev-api.infiniteaudience.ai/v1/schema/fields';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev-api.infiniteaudience.ai/v1/schema/fields \
  --header 'Authorization: Bearer <token>'

Returns the Attribute Catalog — every attribute you can use in the filters array when calling the count, lookup, crosstab, and overlap endpoints. For each attribute you’ll get its data type, a plain-English description, a suggested UI widget, and (for categorical attributes) the allowed values. Use this to build dynamic filter UIs or to validate attribute names before submitting a query. Only filterable attributes are returned — there’s no parameter to widen this set. The response is cached and refreshed nightly. Requires ‘discovery’ scope.

Authorizations

bearerAuth

Responses

200

Attribute Catalog.

application/json

object

fields

required

Array<object>

object

field_name

required

string

table_name

required

string

bq_type

required

string

description

required

Plain-English description of the attribute.

string

filterable

required

boolean

operators

required

Array<string>

ui_hint

required

string | null

ui_label

required

string

enum_values

required

Array<string> | null

value_labels

required

One of:

object
null

object

key

additional properties

string

is_pii

required

boolean

groupable

required

boolean

anchor

required

boolean

data_level

required

string | null

category_display_name

required

string | null

category

string

cached_at

required

string format: date-time

Example

{
  "fields": [
    {
      "field_name": "gender",
      "table_name": "demographics.consumers_v2",
      "bq_type": "STRING",
      "description": "Age bracket of the consumer (e.g. 25-34)",
      "operators": [
        "=",
        "!=",
        "IN",
        "NOT IN"
      ],
      "ui_hint": "multi_select",
      "ui_label": "Gender",
      "enum_values": [
        "18-24",
        "25-34",
        "35-44",
        "45-54",
        "55+"
      ],
      "category_display_name": "Demographics & Household"
    }
  ]
}

401

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

missing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}