# Companies The companies endpoints provide access to company statistics, visitors per company, timeseries chart data, and CSV exports. ## Endpoints | Method | Path | Description | | ------ | ------------------------------------------------------- | ------------------------------------- | | GET | `/companies` | Get company statistics with filtering | | GET | `/companies/visitors` | Get visitors statistics | | GET | `/companies/{company_id}/visitors` | Get visitors for a company | | GET | `/companies/download` | Download company data as CSV | | GET | `/companies/statistic/{organization_id}/total` | Get total company statistics | | GET | `/companies/statistic/{organization_id}/visitors/chart` | Get 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 | Parameter | Type | Required | Description | | ---------------- | ------- | -------- | ------------------------------------ | | `organizationId` | string | Yes | Organization ID | | `page` | integer | No | Page number (default: 1) | | `limit` | integer | No | Items per page | | `from` | string | No | Start date (ISO format) | | `to` | string | No | End date (ISO format) | | `ICPOnly` | boolean | No | Filter to ICP-matched companies only | | `fields` | string | No | Comma-separated fields to include | ### Response Body Returns a paginated response with company statistics including domains, visitor counts, and related metrics. ### Example ```bash 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 | Parameter | Type | Required | Description | | ---------------- | ------- | -------- | --------------------------------------- | | `organizationId` | string | Yes | Organization ID | | `domain` | string | No | Filter by visitor domain | | `icpSlug` | string | No | Filter by ICP slug | | `page` | integer | No | Page number | | `limit` | integer | No | Items per page | | `from` | string | No | Start date (ISO format) | | `to` | string | No | End date (ISO format) | | `ICPOnly` | boolean | No | Filter to ICP-matched visitors only | | `personaOnly` | boolean | No | Filter to persona-matched visitors only | | `fields` | string | No | Comma-separated fields to include | ### Response Body Returns a paginated response with visitor statistics. ### Example ```bash 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 | Parameter | Type | Description | | ------------ | ------ | ----------- | | `company_id` | string | Company ID | ### Query Parameters | Parameter | Type | Required | Description | | ---------------- | ------- | -------- | --------------------------------------- | | `organizationId` | string | Yes | Organization ID | | `page` | integer | No | Page number | | `limit` | integer | No | Items per page | | `from` | string | No | Start date (ISO format) | | `to` | string | No | End date (ISO format) | | `ICPOnly` | boolean | No | Filter to ICP-matched visitors only | | `personaOnly` | boolean | No | Filter to persona-matched visitors only | | `fields` | string | No | Comma-separated fields to include | ### Response Body Returns a paginated response with visitors for the specified company. ### Example ```bash 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 | Parameter | Type | Required | Description | | ---------------- | ------- | -------- | ---------------------------------------------------------- | | `organizationId` | string | Yes | Organization ID | | `statisticType` | string | Yes | Export type: `companies`, `companyVisitors`, or `visitors` | | `companyId` | string | No | Company ID (for `companyVisitors` type) | | `from` | string | No | Start date (ISO format) | | `to` | string | No | End date (ISO format) | | `ICPOnly` | boolean | No | Filter to ICP-matched data only | | `personaOnly` | boolean | No | Filter to persona-matched data only | | `fields` | string | No | Comma-separated fields to include | ### Response Body Returns a CSV file (`Content-Type: text/csv`). ### Example ```bash 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 | Parameter | Type | Description | | ----------------- | ------ | --------------- | | `organization_id` | string | Organization ID | ### Query Parameters | Parameter | Type | Required | Description | | ------------- | ------- | -------- | ----------------------------------- | | `from` | string | Yes | Start date (ISO format) | | `to` | string | Yes | End date (ISO format) | | `ICPOnly` | boolean | No | Filter to ICP-matched data only | | `personaOnly` | boolean | No | Filter to persona-matched data only | ### Response Body Returns total counts and aggregate metrics for the period. ### Example ```bash 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 | Parameter | Type | Description | | ----------------- | ------ | --------------- | | `organization_id` | string | Organization ID | ### Query Parameters | Parameter | Type | Required | Description | | ------------- | ------- | -------- | ----------------------------------- | | `from` | string | Yes | Start date (ISO format) | | `to` | string | Yes | End date (ISO format) | | `ICPOnly` | boolean | No | Filter to ICP-matched data only | | `personaOnly` | boolean | No | Filter to persona-matched data only | ### Response Body Returns an array of data points with timestamps and counts for chart rendering. ### Example ```bash 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" ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.bullseye.so/api-reference/companies.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.