Login

exportCompaniesAnalytics.title

exportCompaniesAnalytics.description

Export analytics data

Free

Export analytics data about companies in various formats. You can choose specific attributes to export or get a full export of all analytics attributes. The endpoint returns a file download in your chosen format.

Query parameters

actionIdnumber (optional)

The action ID to filter analytics.

attributesarray (optional)

An array of analytics attributes to export. Required if full is not true.

Possible values

about.businessType
about.industries
about.industry
about.totalEmployees
about.yearFounded
analytics.monthlyVisitors
apps
codes.naics
codes.sic
contacts
Show 13 more
formatstring (optional)

The format of the exported file (defaults to json).

Possible values

csv
json
txt
xls
xml
fullboolean (optional)

Whether to export all analytics attributes.

listIdnumber (optional)

Filter analytics to a specific list.

queryarray (optional)

An array of conditions to filter the companies.

Make sure this parameter is stringified and encoded.

GET
https://api.thecompaniesapi.com/v2/companies/analytics/export?query=%5B%7B%22attribute%22%3A%22about.industries%22%2C%22operator%22%3A%22or%22%2C%22sign%22%3A%22equals%22%2C%22values%22%3A%5B%22retail%22%2C%22internet%22%2C%22services%22%5D%7D%2C%7B%22attribute%22%3A%22locations.headquarters.country.code%22%2C%22operator%22%3A%22or%22%2C%22sign%22%3A%22equals%22%2C%22values%22%3A%5B%22us%22%2C%22fr%22%2C%22gb%22%5D%7D%5D&token=XXXXXX
The endpoint that defines your search criteria.
sizenumber (optional)

The number of results to return.

sortstring (optional)

The sort order of the results.

Possible values

asc
desc

Response

dataobject

An array of analytics data points containing counts and percentages for each value

metaobject

Additional metadata about the results.

Endpoint
GET
https://api.thecompaniesapi.com/v2/companies/analytics/export