API Documentation

⛔ DEPRECATED (2026-05-01) — Custom Macro Regional Sentiment Query

post deprecated
https://dev-copilot-api.permutable.ai/v1/macro/query/regional

DEPRECATED — Removal date: 2026-05-01

This endpoint will be permanently removed on 2026-05-01. Migrate to the replacement shown in the description below before that date. See the Deprecated Endpoints guide for the full migration list.

Use POST /headlines/index/macro/query/regional instead. 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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

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

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

countries

List of countries to filter by

topics

List of topics to filter by

sources

List of sources to filter by

languages

List of languages to filter by

source_countries

List of source countries to filter by

string
enum
Defaults to COMBINED

Type of index to filter by. Get these from GET /indices

Allowed:
1 to 1000

Number of records per page

Pagination cursor token

Only consider articles extracted within hourly decision window

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

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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 6 days ago