Proof Points Top Terms

Returns top terms across all proof point document types.

Authorization

APIKeyHeader license

x-api-key<token>

In: header

Scope: license

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids?array<string>|

Filter by document global ids.

organizationIds?array<>|

Filter by organization ids.

topicQuery?|

Lucene-lite topic filter. Terms are topic UUIDs combined with AND / OR / NOT. Fields: title, summary, document.

gpeQuery?|

Lucene-lite parent-GPE filter. Terms are GPE UUIDs combined with AND / OR / NOT. Fields: title, summary, document.

query?string|null

groupQuery?|

Lucene-lite source-group filter. Terms are source-group UUIDs combined with AND / OR / NOT. Always matches groups.

languages?array<>|null

sourceIds?array<>|null

start?|

Only consider nodes/events on or after this datetime.

end?|

Only consider nodes/events on or before this datetime.

includeStart?Includestart

Whether the start bound is inclusive (>=) or exclusive (>).

Defaulttrue

includeEnd?Includeend

Whether the end bound is inclusive (<=) or exclusive (<).

Defaulttrue

debug?Debug

Enable debug mode.

Defaultfalse

field*ProofPointTopTermsField

Value in"topic" | "organization"

take?Take

Number of top terms to return (default 10).

Default10

Response Body

`application/json`

curl -X POST "https://connect-api.trendtracker.ai/proof-points/top-terms" \  -H "Content-Type: application/json" \  -d '{    "field": "topic"  }'

[
  {
    "id": "string",
    "name": "string",
    "count": 0
  }
]

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Proof Points Top Terms

Authorization

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`