Skip to main content
POST
/
api
/
v2
/
supersearch-enrichment
/
signal-keywords-facet
Facet keywords for a signal category
curl --request POST \
  --url https://api.instantly.ai/api/v2/supersearch-enrichment/signal-keywords-facet \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "linkedin_post_contact",
  "field": "tags"
}
'
{
  "keywords": [
    {
      "keyword": "artificial intelligence",
      "count": 22418
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
category
string
required

Signal category to facet against (e.g. linkedin_post_contact).

Example:

"linkedin_post_contact"

​
field
string
required

Indexed keyword field on autobound_signals to aggregate on.

Example:

"tags"

​
prefix
string

Optional case-insensitive prefix to narrow the tokens returned.

Example:

"ai"

​
limit
number

Max number of keyword buckets to return (1-100).

Required range: 1 <= x <= 100
Example:

20

Response

Default Response

​
keywords
object[]

Keyword tokens ordered by descending frequency.