Api ReferenceCompanies

Companies

The companies endpoints provide access to company statistics, visitors per company, timeseries chart data, and CSV exports.

Endpoints

MethodPathDescription
GET/companiesGet company statistics with filtering
GET/companies/visitorsGet visitors statistics
GET/companies/\{company_id\}/visitorsGet visitors for a company
GET/companies/downloadDownload company data as CSV
GET/companies/statistic/\{organization_id\}/totalGet total company statistics
GET/companies/statistic/\{organization_id\}/visitors/chartGet visitor chart timeseries data

Get Company Statistics

Returns statistics for companies matching the provided filters. Supports pagination and date range filtering.

Method: GET
Path: /companies

Query Parameters

ParameterTypeRequiredDescription
organizationIdstringYesOrganization ID
pageintegerNoPage number (default: 1)
limitintegerNoItems per page
fromstringNoStart date (ISO format)
tostringNoEnd date (ISO format)
ICPOnlybooleanNoFilter to ICP-matched companies only
fieldsstringNoComma-separated fields to include

Response Body

Returns a paginated response with company statistics including domains, visitor counts, and related metrics.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/companies?organizationId=org_abc123&page=1&limit=20&from=2025-01-01&to=2025-01-31" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

Get Visitors Statistics

Returns visitor statistics for the organization, optionally filtered by domain or ICP.

Method: GET
Path: /companies/visitors

Query Parameters

ParameterTypeRequiredDescription
organizationIdstringYesOrganization ID
domainstringNoFilter by visitor domain
icpSlugstringNoFilter by ICP slug
pageintegerNoPage number
limitintegerNoItems per page
fromstringNoStart date (ISO format)
tostringNoEnd date (ISO format)
ICPOnlybooleanNoFilter to ICP-matched visitors only
personaOnlybooleanNoFilter to persona-matched visitors only
fieldsstringNoComma-separated fields to include

Response Body

Returns a paginated response with visitor statistics.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/companies/visitors?organizationId=org_abc123&page=1&limit=50" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

Get Company Visitors

Returns visitors associated with a specific company.

Method: GET
Path: /companies/\{company_id\}/visitors

Path Parameters

ParameterTypeDescription
company_idstringCompany ID

Query Parameters

ParameterTypeRequiredDescription
organizationIdstringYesOrganization ID
pageintegerNoPage number
limitintegerNoItems per page
fromstringNoStart date (ISO format)
tostringNoEnd date (ISO format)
ICPOnlybooleanNoFilter to ICP-matched visitors only
personaOnlybooleanNoFilter to persona-matched visitors only
fieldsstringNoComma-separated fields to include

Response Body

Returns a paginated response with visitors for the specified company.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/companies/comp_xyz123/visitors?organizationId=org_abc123&page=1&limit=20" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

Download Company Data

Downloads company, company visitor, or visitor data as a CSV file.

Method: GET
Path: /companies/download

Query Parameters

ParameterTypeRequiredDescription
organizationIdstringYesOrganization ID
statisticTypestringYesExport type: companies, companyVisitors, or visitors
companyIdstringNoCompany ID (for companyVisitors type)
fromstringNoStart date (ISO format)
tostringNoEnd date (ISO format)
ICPOnlybooleanNoFilter to ICP-matched data only
personaOnlybooleanNoFilter to persona-matched data only
fieldsstringNoComma-separated fields to include

Response Body

Returns a CSV file (Content-Type: text/csv).

Example

curl -X GET "https://api.app.bullseye.so/api/v1/companies/download?organizationId=org_abc123&statisticType=visitors&from=2025-01-01&to=2025-01-31" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -o visitors.csv

Get Total Statistics

Returns aggregate statistics for the organization over a date range.

Method: GET
Path: /companies/statistic/\{organization_id\}/total

Path Parameters

ParameterTypeDescription
organization_idstringOrganization ID

Query Parameters

ParameterTypeRequiredDescription
fromstringYesStart date (ISO format)
tostringYesEnd date (ISO format)
ICPOnlybooleanNoFilter to ICP-matched data only
personaOnlybooleanNoFilter to persona-matched data only

Response Body

Returns total counts and aggregate metrics for the period.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/companies/statistic/org_abc123/total?from=2025-01-01&to=2025-01-31" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"

Get Visitor Chart Data

Returns timeseries data for visitor counts, suitable for charting trends over time.

Method: GET
Path: /companies/statistic/\{organization_id\}/visitors/chart

Path Parameters

ParameterTypeDescription
organization_idstringOrganization ID

Query Parameters

ParameterTypeRequiredDescription
fromstringYesStart date (ISO format)
tostringYesEnd date (ISO format)
ICPOnlybooleanNoFilter to ICP-matched data only
personaOnlybooleanNoFilter to persona-matched data only

Response Body

Returns an array of data points with timestamps and counts for chart rendering.

Example

curl -X GET "https://api.app.bullseye.so/api/v1/companies/statistic/org_abc123/visitors/chart?from=2025-01-01&to=2025-01-31" 
  -H "X-API-Key: bsk_live_your_api_key_here" 
  -H "Content-Type: application/json"