Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Companies API analytics API

The analytics API from The Companies API — 2 operation(s) for analytics.

The Companies API analytics API is one of 12 APIs that The Companies API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include analytics. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.thecompaniesapi.com.

2 operations 2 paths 1 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.thecompaniesapi.com/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

The Companies API analytics API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey).

  • apiKey — The API key to use for authentication, you can get it from your API tokens page.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

analytics 2
GET
/v2/companies/analytics
Fetch analytics data for search segmentations and lists.
fetchCompaniesAnalytics 6 params → 200401
POST
/v2/companies/analytics/export
Export analytics data for search segmentations and lists.
exportCompaniesAnalytics body → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is SegmentationCondition (5 properties). Each schema is shown below with its type and property counts.

SegmentationCondition
object
A condition for our platform segmentation engine.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thecompaniesapi-analytics-api-openapi.yml Raw ↑

Other APIs The Companies API publishes across the network.

The Companies API actions API
The Companies API companies API
The Companies API industries API
The Companies API job-titles API
The Companies API lists API
The Companies API locations API
The Companies API prompts API
The Companies API teams API
The Companies API technologies API
The Companies API users API
The Companies API utilities API