News Search

Submit a async query

POST /api/v2/query-async

Primary end-point for query Athena news database. Used in conjunction with /api/v2/get-results.

Body

Name
Type
Description

query

string (required)

Query string

key_phrases

string (optional)

Key phrases to refine articles results

api_key

string (required)

Your Athena API key.

sites

array (optional)

Array of strings ["cnn.com","nytimes.com"]

start_date

date (optional)

Date in ISO 8601 format

end_date

date (optional)

Date in ISO 8601 format

toggle_state

string (optional)

All Articles or Encoded Articles

embeddings

boolean (optional [true / false])

Returns embeddings with articles

page

int (required)

Page to iterate through results

language

string (optional)

Defaults to 'all'. See supported languages

sort_order

string (optional)

"Relevance" or "Date Published". Defaults to "Relevance".

traffic_rank

int (optional)

Filters search to only sites based on percentile monthly traffic.

Example:

95 will filter results to top 5% of news sites.

Response

Name
Type
Description

query_id

string

Used for querying job status and retrieving results from /api/v2/get-results

state

string

Query success or fail

Get results

POST /api/v2/get-results

End-point for retrieving query results fom Athena News API.

Name
Type
Description

query_id

string (required)

Use the query id issued in response to submitting your query to /api/v2/query-async

api_key

string (required)

Your Athena API key.

page

int (optional)

Defaults to first page of results unless otherwise specified

Response

Name
Type
Description

totalResults

int

Number of results

articles

array (optional)

Array of articles

state

date (optional)

Query success, fail, or pending

Last updated