Skip to content

List recent task entities​

GET
/entities

Lists aggregated entities observed in recent SourceFinder tasks. Use window, or explicit from/to RFC3339 timestamps, to control the time range.

Authorizations​

apiKeyAuth

API key passed in the CP-X-API-KEY header.

Type
API Key (header: CP-X-API-KEY)

Parameters​

Query Parameters

window

Relative lookback window such as 24h or 6h. Defaults to 24h when from is omitted.

Type
string
Example"24h"
from

Inclusive RFC3339 window start. Overrides window when provided.

Type
string
Format
"date-time"
to

RFC3339 window end. Defaults to the current time.

Type
string
Format
"date-time"

Responses​

Aggregated task entities

application/json
JSON
{
  
"data": {
  
  
"entities": [
  
  
  
{
  
  
  
  
"name": "string",
  
  
  
  
"canonical_name": "string",
  
  
  
  
"type": "string",
  
  
  
  
"official_domains": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"official_x_accounts": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"count": 0
  
  
  
}
  
  
]
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​