Pulse Intelligence
Reference & Discovery

List filters for a resource

Return the filterable fields and columns available for a resource — the same field set its search endpoint accepts. A browsable version of this vocabulary is published in the [filter & column reference](https://docs.pulseintelligence.com/docs/guides/filter-reference).

GET/v1/filters/{resource}/

Authorization

apiKeyAuth
AuthorizationBearer <token>

Organization API key, format pulse_<prefix>_<secret>. Created by an organization admin in Settings -> API Keys.

In: header

Path Parameters

resource*string

The resource to describe filters for: companies or mining-assets.

Value in

  • "companies"
  • "mining-assets"

Response Body

The resource's filter/column vocabulary.

The resource's current filter vocabulary: every filterable field and every response column its search endpoint accepts.

curl -X GET "https://example.com/v1/filters/companies/" \  -H "Authorization: Bearer $PULSE_API_KEY"
{  "resource": "companies",  "filters": [    {      "field": "market_cap_in_usd",      "operators": [        "gte",        "lte"      ],      "type": "number",      "unit": "USD",      "options": null,      "options_endpoint": null,      "label": "Market Cap"    },    {      "field": "industry",      "operators": [        "has_any"      ],      "type": "select",      "unit": null,      "options": [        {          "id": "mining",          "label": "Mining"        },        {          "id": "steel",          "label": "Steel"        }      ],      "options_endpoint": null,      "label": "Industry"    },    {      "field": "commodities",      "operators": [        "has_any",        "has_only"      ],      "type": "select",      "unit": null,      "options": null,      "options_endpoint": "/commodities/options/",      "label": "Primary commodities"    }  ],  "columns": [    {      "key": "name",      "title": "Company",      "type": "string",      "sortable": true    },    {      "key": "market_cap_in_usd",      "title": "Market Cap",      "type": "number",      "sortable": true    },    {      "key": "cash_runway_months",      "title": "Runway (months)",      "type": "number",      "sortable": true    }  ]}