fetchCompaniesAnalytics.title

fetchCompaniesAnalytics.description

Fetch analytics data for a query or your lists

Analyze and gain insights into companies that match your specified criteria. You can explore various attributes including business type, industry, employee count, and more. This endpoint also enables data export in multiple formats.

Query parameters

attributestring (required)

The analytics attribute to aggregate data for. This determines which field will be used to group and analyze the companies.

Possible values

about.businessType

about.industries

about.industry

about.totalEmployees

about.yearFounded

analytics.monthlyVisitors

apps

codes.naics

codes.sic

contacts

13 others

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?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

The endpoint that defines your search criteria.

listIdsarray (optional)

Filter analytics to specific lists.

sizenumber (optional)

The maximum number of companies to include in the analysis (between 1 and 10,000). The default value is 100.

Possible values

1-10000

sortstring (optional)

The sort order of the results.

Possible values

asc

desc

Response

dataarray

Array of aggregated metrics (counts and percentages) for each value of the specified attribute.

metaobject

Additional metadata about the results.

Endpoint

GET

https://api.thecompaniesapi.com/v2/companies/analytics