API Documentation

Aggregated Live Macro Regional Sentiment

get
https://dev-copilot-api.permutable.ai/v1/headlines/index/macro/live/regional/

Retrieves aggregated sentiment data for macroeconomic topics, over the last 24 hours for HOUR interval and 7 days for DAY interval (max 1000 records). Filters by countries.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Query Params
string
Defaults to ALL

Topic preset to filter by. Available presets: ALL, ECONOMIC DATA, MONETARY POLICY, FISCAL POLICY, DISASTERS AND CONFLICT, POLITICS, EXTREME WEATHER across all models. 'FINANCIAL MARKETS' is available for macro_2 and macro_3. Defaults to 'ALL'.

string
enum
Defaults to COMBINED

Type of index to filter by. Can be COMBINED, DOMESTIC, INTERNATIONAL

Allowed:
string
enum
Defaults to HOUR

Time interval to filter by. Can be HOUR, DAY

Allowed:

Only return the datapoints that had associated headlines. Useful for memory saving as less data points returned. WARNING: If you set this to False, the response will be very large and may exceed the maximum response size. Best practice is to set this to True and fill null values client side.

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

string
Defaults to ALL

Country preset or individual country name to filter by. Available presets: ALL, G7, EUROPE, ASIA, EAST_ASIA, SOUTH_ASIA, SOUTHEAST_ASIA, AMERICAS, AFRICA, DEVELOPED, DEVELOPING. Defaults to 'ALL'. Get individual country names from GET /countries and presets from GET /countries/presets

string
Defaults to ALL

Language preset to filter by. Available presets: ALL, ENGLISH, EUROPEAN, EUROPEAN_MAJOR, ASIAN, EAST_ASIAN, SOUTH_ASIAN, SOUTHEAST_ASIAN, MIDDLE_EASTERN, AFRICAN, LATIN_AMERICAN. Defaults to 'ALL'. Get individual language codes from GET /languages and presets from GET /languages/presets

string
Defaults to ALL

Source country preset or individual country name to filter by. Available presets: ALL, G7, EUROPE, ASIA, EAST_ASIA, SOUTH_ASIA, SOUTHEAST_ASIA, AMERICAS, AFRICA, DEVELOPED, DEVELOPING. Defaults to 'ALL'. Get individual country names from GET /countries and presets from GET /countries/presets

string
Defaults to ALL

Source preset to filter by. Available presets: ALL, FINANCIAL. Defaults to 'ALL'. Get individual source names from GET /sources and presets from GET /sources/presets

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