---
title: "GET /v2/companies/analytics"
method: GET
path: "/v2/companies/analytics"
tags: ["companies", "analytics"]
---

# GET /v2/companies/analytics

`GET /v2/companies/analytics`

## Request

- Base URL: `https://api.thecompaniesapi.com`
- URL: `https://api.thecompaniesapi.com/v2/companies/analytics`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/thecompaniesapi/apis/the-companies-api/docs/v2/companies/analytics/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch analytics data for search segmentations and lists.

## Query parameters

- `actionId` number
- `attribute` 'about.businessType' | 'about.industries' | 'about.industry' | 'about.totalEmployees' | 'about.yearFounded' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.tld' | 'finances.revenue' | 'finances.stockExchange' | 'locations.headquarters.city.code' | 'locations.headquarters.continent.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'technologies.active' | 'technologies.categories', required
- `listId` number
- `query` SegmentationCondition[]
  - `attribute` 'about.businessType' | 'about.industries' | 'about.industry' | 'about.name' | 'about.totalEmployees' | 'about.yearFounded' | 'ai.search' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.domain' | 'domain.tld' | 'finances.revenue' | 'finances.stockExchange' | 'locations.headquarters.city.code' | 'locations.headquarters.continent.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.listIds' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'socials.linkedin.id' | 'technologies.active' | 'technologies.categories' | 'urls', required
  - `blockedOperator` boolean
  - `operator` 'and' | 'or', required
  - `sign` 'equals' | 'exactEquals' | 'greater' | 'lower' | 'notEquals', required
  - `values` union[], required
    - union
      - string
      - number
- `size` number
- `sort` 'asc' | 'desc'

## Response `200`

Fetch analytics data for search segmentations and lists.

- object
  - `data` object[], required
    - `count` number, required
    - `name` string, required
    - `percentageOfAll` number, required
    - `percentageOfTotal` number, required
  - `meta` object, required
    - `listId` number
    - `query` SegmentationCondition[], required
      - `attribute` 'about.businessType' | 'about.industries' | 'about.industry' | 'about.name' | 'about.totalEmployees' | 'about.yearFounded' | 'ai.search' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.domain' | 'domain.tld' | 'finances.revenue' | 'finances.stockExchange' | 'locations.headquarters.city.code' | 'locations.headquarters.continent.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.listIds' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'socials.linkedin.id' | 'technologies.active' | 'technologies.categories' | 'urls', required
      - `blockedOperator` boolean
      - `operator` 'and' | 'or', required
      - `sign` 'equals' | 'exactEquals' | 'greater' | 'lower' | 'notEquals', required
      - `values` union[], required
        - union
          - string
          - number
    - `totalDatapoints` number, required
    - `totalDocuments` number, required
    - `totalValues` number, required

## Other responses

- `401`: The error message

---

[API](https://skmtc.dev/thecompaniesapi/apis/the-companies-api.md) - [All operations](https://skmtc.dev/thecompaniesapi/apis/the-companies-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thecompaniesapi/apis/the-companies-api/revisions/f8bfc2d10b71?raw)
