List available filters

GET
/filters

Lists the audience filters an opportunity's filters can use, with each one's slug, type and supported operators. The catalog is the same for every organization and is not paginated. A filter with an options_url takes values from a fixed list: read them from GET /filters/{filter_slug}/options and send their ids. integer--age takes a $gte / $lte range within min and max, and the two reference-- filters take opportunity ids.

Authorization

apiKey
Authorization<token>

API key as Bearer token: Authorization: Bearer

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://terac.com/api/external/v2/filters"
{
  "data": [
    {
      "slug": "string",
      "name": "string",
      "type": "string",
      "category": "string",
      "operators": [
        "string"
      ],
      "min": 0,
      "max": 0,
      "options_url": "string"
    }
  ]
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required. Include Authorization: Bearer <key> header."
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This account is not permitted to use the API."
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 61 seconds."
  }
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Get tracked hours for one submission GET

Hours this submission's participant worked on its opportunity, one row per date. Time spent on your other opportunities, and time clocked in but not spent on work, is not included. The current day is partial and refreshes through the day; `last_updated_at` says when the hours were last refreshed. Returns exactly this submission's participant's rows from the opportunity response for the same range.

List options for a filter GET

Lists the allowed values for one filter; send an option's `id`, not its `name`, as the value in an opportunity's `filters`. `search` matches ids, names and alternate names, ignoring case and accents. Results are paged by number with `page` and `per_page`, and `meta.total` counts every match. State options need `country_id`, and city options need `country_id` with an optional `state_id`; without `country_id` both lists are empty. An unknown `filter_slug` returns 400.