Custom Macro Topic Sentiment Query

post

https://dev-copilot-api.permutable.ai/v1/headlines/index/macro/query/global

Execute complex custom queries for macro sentiment data with advanced filtering, aggregation, and analysis capabilities. Use this endpoint for complex filtering that goes beyond standard presets.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

model_id

string

required

Model ID to filter by. Get these from GET /models

start_date

Start date for the query (YYYY-MM-DD format). Defaults to 30 days ago

end_date

End date for the query (YYYY-MM-DD format). Defaults to today

sources

List of news sources to filter by

languages

List of 2-digit language codes

topic_names

List of macro topic names to filter by

strict

Only consider articles extracted within hourly decision window

sparse

Only return the datapoints that had associated headlines. Useful for memory saving as less data points returned.

align_to_period_end

Align publication_time timestamps to the end of each time period instead of the start. For example, hourly data would be aligned to 10:00:00 instead of 09:00:00.

limit

1 to 1000

Number of records per page

next_token

Pagination cursor token

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200Successful Response

400Bad Request — invalid or missing query parameters

403Forbidden — missing API key, invalid API key, or insufficient permissions

404Not Found — the requested resource does not exist

429Too Many Requests — rate limit exceeded; slow down and retry

500Internal Server Error — an unexpected error occurred on the server