Skip to main content
POST
/
expansions
/
dashboard
Expansion Overview
curl --request POST \
  --url https://api.pubrio.com/expansions/dashboard \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "froms": [
    "US",
    "GB"
  ],
  "tos": [
    "US",
    "GB"
  ],
  "exclude_froms": [
    "US",
    "GB"
  ],
  "exclude_tos": [
    "US",
    "GB"
  ],
  "stages": [
    "committing",
    "expanding"
  ],
  "momentum": [
    "accelerating",
    "advancing"
  ],
  "freshness": [
    "fresh",
    "cooling"
  ],
  "scopes": [
    "entering_new_market"
  ],
  "ahead_of_pace": false,
  "signal_types": [
    "EXEC",
    "HIRE"
  ],
  "signal_strengths": [
    "high",
    "very_high"
  ],
  "min_signal_count": 3,
  "only_contraction": false,
  "verticals": [
    123
  ],
  "vertical_categories": [
    123
  ],
  "vertical_sub_categories": [
    123
  ],
  "technologies": [
    123
  ],
  "employees": [
    [
      1,
      10
    ],
    [
      11,
      20
    ],
    [
      10001
    ]
  ],
  "revenues": [
    0,
    100000
  ],
  "founded_dates": [
    2018,
    2024
  ],
  "keywords": [
    "ecommerce",
    "ai",
    "fintech"
  ],
  "companies": [
    "stripe.com",
    "https://www.linkedin.com/company/airbnb",
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "job_locations": [
    "US",
    "SG",
    "CN"
  ],
  "job_exclude_locations": [
    "CN",
    "US",
    "RU",
    "CA"
  ],
  "job_posted_dates": [
    "2025-01-01",
    "2025-01-10"
  ],
  "job_titles": [
    "sales manager",
    "marketing manager"
  ],
  "advertisement_target_locations": [
    "TW",
    "AE",
    "NO"
  ],
  "advertisement_exclude_target_locations": [
    "IS",
    "GB",
    "FR",
    "IE",
    "ES"
  ],
  "advertisement_search_terms": [
    "asus"
  ],
  "advertisement_start_dates": [
    "2025-12-25",
    "2025-12-25"
  ],
  "advertisement_end_dates": [
    "2025-12-25",
    "2025-12-25"
  ],
  "news_categories": [
    "launches"
  ],
  "news_published_dates": [
    "2025-01-01",
    "2025-01-10"
  ],
  "transitioned_dates": [
    "2026-06-01",
    "2026-06-29"
  ],
  "window_days": 90,
  "select_size": 250,
  "flows_size": 50,
  "profile_id": 123
}
'
import requests

url = "https://api.pubrio.com/expansions/dashboard"

payload = {
    "froms": ["US", "GB"],
    "tos": ["US", "GB"],
    "exclude_froms": ["US", "GB"],
    "exclude_tos": ["US", "GB"],
    "stages": ["committing", "expanding"],
    "momentum": ["accelerating", "advancing"],
    "freshness": ["fresh", "cooling"],
    "scopes": ["entering_new_market"],
    "ahead_of_pace": False,
    "signal_types": ["EXEC", "HIRE"],
    "signal_strengths": ["high", "very_high"],
    "min_signal_count": 3,
    "only_contraction": False,
    "verticals": [123],
    "vertical_categories": [123],
    "vertical_sub_categories": [123],
    "technologies": [123],
    "employees": [[1, 10], [11, 20], [10001]],
    "revenues": [0, 100000],
    "founded_dates": [2018, 2024],
    "keywords": ["ecommerce", "ai", "fintech"],
    "companies": ["stripe.com", "https://www.linkedin.com/company/airbnb", "550e8400-e29b-41d4-a716-446655440000"],
    "job_locations": ["US", "SG", "CN"],
    "job_exclude_locations": ["CN", "US", "RU", "CA"],
    "job_posted_dates": ["2025-01-01", "2025-01-10"],
    "job_titles": ["sales manager", "marketing manager"],
    "advertisement_target_locations": ["TW", "AE", "NO"],
    "advertisement_exclude_target_locations": ["IS", "GB", "FR", "IE", "ES"],
    "advertisement_search_terms": ["asus"],
    "advertisement_start_dates": ["2025-12-25", "2025-12-25"],
    "advertisement_end_dates": ["2025-12-25", "2025-12-25"],
    "news_categories": ["launches"],
    "news_published_dates": ["2025-01-01", "2025-01-10"],
    "transitioned_dates": ["2026-06-01", "2026-06-29"],
    "window_days": 90,
    "select_size": 250,
    "flows_size": 50,
    "profile_id": 123
}
headers = {
    "pubrio-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    froms: ['US', 'GB'],
    tos: ['US', 'GB'],
    exclude_froms: ['US', 'GB'],
    exclude_tos: ['US', 'GB'],
    stages: ['committing', 'expanding'],
    momentum: ['accelerating', 'advancing'],
    freshness: ['fresh', 'cooling'],
    scopes: ['entering_new_market'],
    ahead_of_pace: false,
    signal_types: ['EXEC', 'HIRE'],
    signal_strengths: ['high', 'very_high'],
    min_signal_count: 3,
    only_contraction: false,
    verticals: [123],
    vertical_categories: [123],
    vertical_sub_categories: [123],
    technologies: [123],
    employees: [[1, 10], [11, 20], [10001]],
    revenues: [0, 100000],
    founded_dates: [2018, 2024],
    keywords: ['ecommerce', 'ai', 'fintech'],
    companies: [
      'stripe.com',
      'https://www.linkedin.com/company/airbnb',
      '550e8400-e29b-41d4-a716-446655440000'
    ],
    job_locations: ['US', 'SG', 'CN'],
    job_exclude_locations: ['CN', 'US', 'RU', 'CA'],
    job_posted_dates: ['2025-01-01', '2025-01-10'],
    job_titles: ['sales manager', 'marketing manager'],
    advertisement_target_locations: ['TW', 'AE', 'NO'],
    advertisement_exclude_target_locations: ['IS', 'GB', 'FR', 'IE', 'ES'],
    advertisement_search_terms: ['asus'],
    advertisement_start_dates: ['2025-12-25', '2025-12-25'],
    advertisement_end_dates: ['2025-12-25', '2025-12-25'],
    news_categories: ['launches'],
    news_published_dates: ['2025-01-01', '2025-01-10'],
    transitioned_dates: ['2026-06-01', '2026-06-29'],
    window_days: 90,
    select_size: 250,
    flows_size: 50,
    profile_id: 123
  })
};

fetch('https://api.pubrio.com/expansions/dashboard', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pubrio.com/expansions/dashboard",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'froms' => [
        'US',
        'GB'
    ],
    'tos' => [
        'US',
        'GB'
    ],
    'exclude_froms' => [
        'US',
        'GB'
    ],
    'exclude_tos' => [
        'US',
        'GB'
    ],
    'stages' => [
        'committing',
        'expanding'
    ],
    'momentum' => [
        'accelerating',
        'advancing'
    ],
    'freshness' => [
        'fresh',
        'cooling'
    ],
    'scopes' => [
        'entering_new_market'
    ],
    'ahead_of_pace' => false,
    'signal_types' => [
        'EXEC',
        'HIRE'
    ],
    'signal_strengths' => [
        'high',
        'very_high'
    ],
    'min_signal_count' => 3,
    'only_contraction' => false,
    'verticals' => [
        123
    ],
    'vertical_categories' => [
        123
    ],
    'vertical_sub_categories' => [
        123
    ],
    'technologies' => [
        123
    ],
    'employees' => [
        [
                1,
                10
        ],
        [
                11,
                20
        ],
        [
                10001
        ]
    ],
    'revenues' => [
        0,
        100000
    ],
    'founded_dates' => [
        2018,
        2024
    ],
    'keywords' => [
        'ecommerce',
        'ai',
        'fintech'
    ],
    'companies' => [
        'stripe.com',
        'https://www.linkedin.com/company/airbnb',
        '550e8400-e29b-41d4-a716-446655440000'
    ],
    'job_locations' => [
        'US',
        'SG',
        'CN'
    ],
    'job_exclude_locations' => [
        'CN',
        'US',
        'RU',
        'CA'
    ],
    'job_posted_dates' => [
        '2025-01-01',
        '2025-01-10'
    ],
    'job_titles' => [
        'sales manager',
        'marketing manager'
    ],
    'advertisement_target_locations' => [
        'TW',
        'AE',
        'NO'
    ],
    'advertisement_exclude_target_locations' => [
        'IS',
        'GB',
        'FR',
        'IE',
        'ES'
    ],
    'advertisement_search_terms' => [
        'asus'
    ],
    'advertisement_start_dates' => [
        '2025-12-25',
        '2025-12-25'
    ],
    'advertisement_end_dates' => [
        '2025-12-25',
        '2025-12-25'
    ],
    'news_categories' => [
        'launches'
    ],
    'news_published_dates' => [
        '2025-01-01',
        '2025-01-10'
    ],
    'transitioned_dates' => [
        '2026-06-01',
        '2026-06-29'
    ],
    'window_days' => 90,
    'select_size' => 250,
    'flows_size' => 50,
    'profile_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "pubrio-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pubrio.com/expansions/dashboard"

	payload := strings.NewReader("{\n  \"froms\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"tos\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"exclude_froms\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"exclude_tos\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"stages\": [\n    \"committing\",\n    \"expanding\"\n  ],\n  \"momentum\": [\n    \"accelerating\",\n    \"advancing\"\n  ],\n  \"freshness\": [\n    \"fresh\",\n    \"cooling\"\n  ],\n  \"scopes\": [\n    \"entering_new_market\"\n  ],\n  \"ahead_of_pace\": false,\n  \"signal_types\": [\n    \"EXEC\",\n    \"HIRE\"\n  ],\n  \"signal_strengths\": [\n    \"high\",\n    \"very_high\"\n  ],\n  \"min_signal_count\": 3,\n  \"only_contraction\": false,\n  \"verticals\": [\n    123\n  ],\n  \"vertical_categories\": [\n    123\n  ],\n  \"vertical_sub_categories\": [\n    123\n  ],\n  \"technologies\": [\n    123\n  ],\n  \"employees\": [\n    [\n      1,\n      10\n    ],\n    [\n      11,\n      20\n    ],\n    [\n      10001\n    ]\n  ],\n  \"revenues\": [\n    0,\n    100000\n  ],\n  \"founded_dates\": [\n    2018,\n    2024\n  ],\n  \"keywords\": [\n    \"ecommerce\",\n    \"ai\",\n    \"fintech\"\n  ],\n  \"companies\": [\n    \"stripe.com\",\n    \"https://www.linkedin.com/company/airbnb\",\n    \"550e8400-e29b-41d4-a716-446655440000\"\n  ],\n  \"job_locations\": [\n    \"US\",\n    \"SG\",\n    \"CN\"\n  ],\n  \"job_exclude_locations\": [\n    \"CN\",\n    \"US\",\n    \"RU\",\n    \"CA\"\n  ],\n  \"job_posted_dates\": [\n    \"2025-01-01\",\n    \"2025-01-10\"\n  ],\n  \"job_titles\": [\n    \"sales manager\",\n    \"marketing manager\"\n  ],\n  \"advertisement_target_locations\": [\n    \"TW\",\n    \"AE\",\n    \"NO\"\n  ],\n  \"advertisement_exclude_target_locations\": [\n    \"IS\",\n    \"GB\",\n    \"FR\",\n    \"IE\",\n    \"ES\"\n  ],\n  \"advertisement_search_terms\": [\n    \"asus\"\n  ],\n  \"advertisement_start_dates\": [\n    \"2025-12-25\",\n    \"2025-12-25\"\n  ],\n  \"advertisement_end_dates\": [\n    \"2025-12-25\",\n    \"2025-12-25\"\n  ],\n  \"news_categories\": [\n    \"launches\"\n  ],\n  \"news_published_dates\": [\n    \"2025-01-01\",\n    \"2025-01-10\"\n  ],\n  \"transitioned_dates\": [\n    \"2026-06-01\",\n    \"2026-06-29\"\n  ],\n  \"window_days\": 90,\n  \"select_size\": 250,\n  \"flows_size\": 50,\n  \"profile_id\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("pubrio-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.pubrio.com/expansions/dashboard")
  .header("pubrio-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"froms\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"tos\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"exclude_froms\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"exclude_tos\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"stages\": [\n    \"committing\",\n    \"expanding\"\n  ],\n  \"momentum\": [\n    \"accelerating\",\n    \"advancing\"\n  ],\n  \"freshness\": [\n    \"fresh\",\n    \"cooling\"\n  ],\n  \"scopes\": [\n    \"entering_new_market\"\n  ],\n  \"ahead_of_pace\": false,\n  \"signal_types\": [\n    \"EXEC\",\n    \"HIRE\"\n  ],\n  \"signal_strengths\": [\n    \"high\",\n    \"very_high\"\n  ],\n  \"min_signal_count\": 3,\n  \"only_contraction\": false,\n  \"verticals\": [\n    123\n  ],\n  \"vertical_categories\": [\n    123\n  ],\n  \"vertical_sub_categories\": [\n    123\n  ],\n  \"technologies\": [\n    123\n  ],\n  \"employees\": [\n    [\n      1,\n      10\n    ],\n    [\n      11,\n      20\n    ],\n    [\n      10001\n    ]\n  ],\n  \"revenues\": [\n    0,\n    100000\n  ],\n  \"founded_dates\": [\n    2018,\n    2024\n  ],\n  \"keywords\": [\n    \"ecommerce\",\n    \"ai\",\n    \"fintech\"\n  ],\n  \"companies\": [\n    \"stripe.com\",\n    \"https://www.linkedin.com/company/airbnb\",\n    \"550e8400-e29b-41d4-a716-446655440000\"\n  ],\n  \"job_locations\": [\n    \"US\",\n    \"SG\",\n    \"CN\"\n  ],\n  \"job_exclude_locations\": [\n    \"CN\",\n    \"US\",\n    \"RU\",\n    \"CA\"\n  ],\n  \"job_posted_dates\": [\n    \"2025-01-01\",\n    \"2025-01-10\"\n  ],\n  \"job_titles\": [\n    \"sales manager\",\n    \"marketing manager\"\n  ],\n  \"advertisement_target_locations\": [\n    \"TW\",\n    \"AE\",\n    \"NO\"\n  ],\n  \"advertisement_exclude_target_locations\": [\n    \"IS\",\n    \"GB\",\n    \"FR\",\n    \"IE\",\n    \"ES\"\n  ],\n  \"advertisement_search_terms\": [\n    \"asus\"\n  ],\n  \"advertisement_start_dates\": [\n    \"2025-12-25\",\n    \"2025-12-25\"\n  ],\n  \"advertisement_end_dates\": [\n    \"2025-12-25\",\n    \"2025-12-25\"\n  ],\n  \"news_categories\": [\n    \"launches\"\n  ],\n  \"news_published_dates\": [\n    \"2025-01-01\",\n    \"2025-01-10\"\n  ],\n  \"transitioned_dates\": [\n    \"2026-06-01\",\n    \"2026-06-29\"\n  ],\n  \"window_days\": 90,\n  \"select_size\": 250,\n  \"flows_size\": 50,\n  \"profile_id\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.pubrio.com/expansions/dashboard")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"froms\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"tos\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"exclude_froms\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"exclude_tos\": [\n    \"US\",\n    \"GB\"\n  ],\n  \"stages\": [\n    \"committing\",\n    \"expanding\"\n  ],\n  \"momentum\": [\n    \"accelerating\",\n    \"advancing\"\n  ],\n  \"freshness\": [\n    \"fresh\",\n    \"cooling\"\n  ],\n  \"scopes\": [\n    \"entering_new_market\"\n  ],\n  \"ahead_of_pace\": false,\n  \"signal_types\": [\n    \"EXEC\",\n    \"HIRE\"\n  ],\n  \"signal_strengths\": [\n    \"high\",\n    \"very_high\"\n  ],\n  \"min_signal_count\": 3,\n  \"only_contraction\": false,\n  \"verticals\": [\n    123\n  ],\n  \"vertical_categories\": [\n    123\n  ],\n  \"vertical_sub_categories\": [\n    123\n  ],\n  \"technologies\": [\n    123\n  ],\n  \"employees\": [\n    [\n      1,\n      10\n    ],\n    [\n      11,\n      20\n    ],\n    [\n      10001\n    ]\n  ],\n  \"revenues\": [\n    0,\n    100000\n  ],\n  \"founded_dates\": [\n    2018,\n    2024\n  ],\n  \"keywords\": [\n    \"ecommerce\",\n    \"ai\",\n    \"fintech\"\n  ],\n  \"companies\": [\n    \"stripe.com\",\n    \"https://www.linkedin.com/company/airbnb\",\n    \"550e8400-e29b-41d4-a716-446655440000\"\n  ],\n  \"job_locations\": [\n    \"US\",\n    \"SG\",\n    \"CN\"\n  ],\n  \"job_exclude_locations\": [\n    \"CN\",\n    \"US\",\n    \"RU\",\n    \"CA\"\n  ],\n  \"job_posted_dates\": [\n    \"2025-01-01\",\n    \"2025-01-10\"\n  ],\n  \"job_titles\": [\n    \"sales manager\",\n    \"marketing manager\"\n  ],\n  \"advertisement_target_locations\": [\n    \"TW\",\n    \"AE\",\n    \"NO\"\n  ],\n  \"advertisement_exclude_target_locations\": [\n    \"IS\",\n    \"GB\",\n    \"FR\",\n    \"IE\",\n    \"ES\"\n  ],\n  \"advertisement_search_terms\": [\n    \"asus\"\n  ],\n  \"advertisement_start_dates\": [\n    \"2025-12-25\",\n    \"2025-12-25\"\n  ],\n  \"advertisement_end_dates\": [\n    \"2025-12-25\",\n    \"2025-12-25\"\n  ],\n  \"news_categories\": [\n    \"launches\"\n  ],\n  \"news_published_dates\": [\n    \"2025-01-01\",\n    \"2025-01-10\"\n  ],\n  \"transitioned_dates\": [\n    \"2026-06-01\",\n    \"2026-06-29\"\n  ],\n  \"window_days\": 90,\n  \"select_size\": 250,\n  \"flows_size\": 50,\n  \"profile_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "metadata": {
    "filters": {
      "froms": [
        "CN"
      ],
      "tos": [
        "GB"
      ]
    },
    "select_size": 250,
    "flows_size": 50,
    "transitioned_dates": [
      "2026-06-01",
      "2026-06-29"
    ]
  },
  "data": {
    "countries": [
      {
        "country_code": "US",
        "inbound_count": 18,
        "outbound_count": 5,
        "total_companies_with_signals": 23,
        "exploring_count": 8,
        "committing_count": 10,
        "expanding_count": 4,
        "scaling_count": 1,
        "new_transitions_30d": 3,
        "freshest_transition_at": "2026-06-27T14:32:10.000Z"
      }
    ],
    "top_flows": [
      {
        "home_country_code": "SG",
        "country_code": "US",
        "company_count": 5,
        "new_transitions_30d": 1
      }
    ]
  }
}

Authorizations

​
pubrio-api-key
string
header
required

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
​
froms
string[]

Origin markets (ISO 3166-1 alpha-2). Where a company is expanding FROM — its home / HQ countries. Use alone to find companies growing out of these markets; combine with tos for a specific from→to corridor.

Example:
["US", "GB"]
​
tos
string[]

Target markets (ISO 3166-1 alpha-2). Where a company is expanding TO. Use alone to find every company entering these markets; combine with froms for a specific from→to corridor.

Example:
["US", "GB"]
​
exclude_froms
string[]

Origin markets to exclude (ISO 3166-1 alpha-2).

Example:
["US", "GB"]
​
exclude_tos
string[]

Target markets to exclude (ISO 3166-1 alpha-2).

Example:
["US", "GB"]
​
stages
enum<string>[]

Filter to one or more expansion stages. See the Expansion Signals knowledge base for stage definitions.

Available options:
exploring,
committing,
expanding,
scaling,
established
Example:
["committing", "expanding"]
​
momentum
enum<string>[]

Filter by expansion momentum (trajectory through the stages): accelerating (advancing with a mode change), advancing, steady, or pulling_back (retreating or contracting).

Available options:
accelerating,
advancing,
steady,
pulling_back
Example:
["accelerating", "advancing"]
​
freshness
enum<string>[]

Filter by evidence recency: fresh (~30d), cooling (~30-60d), stale (~60-90d), cold (>90d).

Available options:
fresh,
cooling,
stale,
cold
Example:
["fresh", "cooling"]
​
scopes
enum<string>[]

Filter by market-entry scope.

Available options:
entering_new_market,
expanding_within_presence,
established_only
Example:
["entering_new_market"]
​
ahead_of_pace
boolean

Limit to company/market pairs moving faster than the typical pace for that market.

Example:

false

​
signal_types
enum<string>[]

Filter to specific signal types.

Available options:
AD,
NEWS,
INFRA,
PARTNER,
EVENT_PLUS,
EXEC,
OFFICE,
HIRE,
SCALE,
PRODUCT
Example:
["EXEC", "HIRE"]
​
signal_strengths
enum<string>[]

Filter by signal strength buckets.

Available options:
low,
medium,
high,
very_high
Example:
["high", "very_high"]
​
min_signal_count
integer

Minimum number of expansion signals a company must have in the window — "very active / heavy footprint".

Example:

3

​
only_contraction
boolean

When true, return only contraction-flagged expansions (companies scaling back).

Example:

false

​
verticals
integer[]

A list of vertical_id used to search for companies in a specific vertical or industry. To find the ID, call the vertical endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["AI"].

​
vertical_categories
integer[]

A list of vertical_category_id used to search for companies in a specific vertical category. To find the ID, call the vertical category endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["Information Technology"].

​
vertical_sub_categories
integer[]

A list of vertical_sub_category_id used to search for companies in a specific vertical sub-category. To find the ID, call the vertical sub category endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["Software"].

​
technologies
integer[]

A list of tag_id used to search for specific technologies used by companies. To find the ID, call the technology endpoint under the Filters tab.

This filter supports is_enable_similarity_search, once enabled you can enter any free text, e.g. ["Shopify"].

​
employees
string[][]

The number range of employees working for the company. This enables you to find companies based on headcount. You can add multiple ranges to expand your search results.

Check out company size endpoints under the Filters tab for more information.

Example:
[[1, 10], [11, 20], [10001]]
​
revenues
integer[]

Minimum and maximum range of company revenue.

Example:
[0, 100000]
​
founded_dates
integer[]

Years of company founded range. The maximum value founded is the current year.

Example:
[2018, 2024]
​
keywords
string[]

A list of keywords to filter companies by relevance, specialties, or descriptions.

Example:
["ecommerce", "ai", "fintech"]
​
companies
string[]

Scope to specific companies by any mix of domain_search_id, company domain, or a company social media profile URL. Domains and URLs resolve to their best-ranked company.

Example:
[
  "stripe.com",
  "https://www.linkedin.com/company/airbnb",
  "550e8400-e29b-41d4-a716-446655440000"
]
​
job_locations
string[]

ISO 3166-1 alpha-2 (cca2) is used for filtering locations. Check out location endpoints under the Filters tab for more information.

Example:
["US", "SG", "CN"]
​
job_exclude_locations
string[]

Geographic locations to exclude from job posting results.

Example:
["CN", "US", "RU", "CA"]
​
job_posted_dates
string[]

Date range of the posted date. The maximum value is the current day.

Example:
["2025-01-01", "2025-01-10"]
​
job_titles
string[]

Job titles associated with the individuals you aim to locate.

The results will also encompass job titles that include similar terminology, even if they do not match exactly. For instance, searching for software engineer may yield results for individuals with the title senior software engineer.

Example:
["sales manager", "marketing manager"]
​
advertisement_target_locations
string[]

Target geographic locations for advertisements.

Example:
["TW", "AE", "NO"]
​
advertisement_exclude_target_locations
string[]

Geographic locations to exclude from advertisement targeting.

Example:
["IS", "GB", "FR", "IE", "ES"]
​
advertisement_search_terms
string[]

Keywords used to search within advertisement content or titles.

Example:
["asus"]
​
advertisement_start_dates
string<date>[]

Start date range for advertisement filtering.

Example:
["2025-12-25", "2025-12-25"]
​
advertisement_end_dates
string<date>[]

End date range for advertisement filtering.

Example:
["2025-12-25", "2025-12-25"]
​
news_categories
string[]

List of category slugs for searching for specific news categories. To find a slug, call the news categories endpoint under the Filters tab.

Example:
["launches"]
​
news_published_dates
string[]

Date range of the published date. The maximum value is the current day.

Example:
["2025-01-01", "2025-01-10"]
​
transitioned_dates
string<date>[]

ISO date range [start, end] for the watchlist timeline. Defaults to the last 30 days.

Example:
["2026-06-01", "2026-06-29"]
​
window_days
integer

Optional. Size of the rolling window in days. Used when an explicit transitioned_dates range is not supplied; if both are omitted, a default window is used.

Example:

90

​
select_size
integer

Max markets to return (plan-capped).

Example:

250

​
flows_size
integer

Max cross-border flows to return (plan-capped).

Example:

50

​
profile_id
integer

Optional. An identifier for the user profile (workspace) making the request. This is no longer required as the API key already includes your workspace information. If provided, it helps in associating the lookup with a specific user, allowing for data retrieval and credit tracking.

Check out user details endpoints under the Profile tab for more information.

Response

200 - application/json

Market dashboard aggregates.

​
metadata
object
​
data
object

Dashboard container: ranked markets plus the top corridor flows.