Company Report Response Formats

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

The Company Report API allows you to retrieve reports in various formats by modifying the Accept header in your request. This flexibility ensures that you can receive the report in the format that best suits your business needs.

Supported Accept Header Values

The following table outlines the supported Accept header values and their corresponding output formats:

How to Use

To specify the desired format, include the appropriate Accept header value in your API request. For example:

Example Request

GET /company-report/{companyId}
Accept: application/json+pdf
Authorization: Bearer {accessToken}

Best Practices

1. Choose the Right Format: Select the format that aligns with your use case. For example:

   • Use application/pdf for a downloadable, shareable report.
   • Use application/json for programmatic processing of report data.

2. Combine Formats When Needed: If you need both a machine-readable format and a human-readable format, use combined options like application/json+pdf or application/json+html.

3. Test Your Integration: Ensure that your application can handle the selected format(s) correctly by testing the API response with different Accept header values.

By leveraging the flexibility of the Accept header, you can tailor the Company Report API to meet your specific reporting and integration requirements.