Skip to main content

Raw Data - Endpoint Documentation

This article will help you understand Claimlane's raw data endpoint and how to use it.

Support team avatar
Written by Support team
Updated over 2 weeks ago

Let’s start by looking at how to manually export your data from Claimlane.
This is a great way to preview the data structure and see exactly what data will be included in the response. It also allows you to generate the API URL you’ll need if you want to automate the export later.

If you are not interested in this step you can skip to Export Raw Data via API


📍How to Export Data via Claimlane

  1. Log into Claimlane and go to your Inbox.

  2. Click the four-square icon in the top-right corner to access your Company Dashboard.

  3. In the left-hand menu, click “Data Export”.

  4. Choose Organisation type, Data type, Retailers and the time range :

    • Examples: This month, Last 3 months, All time

  5. Click the “Export Data” button.

What happens next?
You’ll receive an email (or multiple emails if the export is large) with your raw data attached.
​
We recommend trying this manually at least once to understand the format and content of the data before using the API.
​


🔗 Accessing the API URL

Once you’ve set up and exported your data:

  1. In the Data Export section, click “Show API URL”.

  2. You’ll get a custom API URL based on your selection and timeframe.

  3. You can use this URL to automate exports using the Claimlane API.
    ​

Export Raw Data via API

Endpoint: /v2/company/raw-data

Auth: API key will be provided by support@claimlane.com
​

⚙️ Query Parameters

  • fromDateUnix (number):
    The start of the date range in Unix timestamp (seconds since 1st January,1970).
    Example: fromDateUnix=1748728800
    ​

  • toDateUnix (number):
    The end of the date range in Unix timestamp (seconds since 1st January,1970).
    Example: toDateUnix=1751320799
    ​

  • organizationIds (string):
    You can find your organisation ID in Claimlane's inbox URL: app.claimlane.com/home/supplier or retailer/yourOrganizationId/


    One or more organization IDs (comma-separated if multiple).
    Example: organizationIds=6156c67d45b7d67ffc34ec45
    ​

  • companyId (string):
    Your company’s Claimlane ID, you can find it in the URL in your company view:
    ​app.claimlane.com/company/yourCompanyId


    Example: companyId=5f7eb30eee60d30d43f79c06
    ​

  • dataType (string):
    The type of data to export.
    Examples: b2cProductData, b2bProductData, b2cWorkloadData, b2cWorkloadData


    ​

  • organizationType (string):
    Filter by type of organization.
    Example: organizationType=retailer, organizationType=supplier
    ​

  • page (number):
    Page number for paginated results (default: 1).
    Example: page=2, page=3, page=4
    ​

  • format=map:

    You can add format=map to your request to receive the data in a flattened, map-friendly format.
    Instead of returning deeply nested arrays or objects, the response is structured in a more Power BI–friendly format that’s easier to parse and visualize.
    ​

⚠️ Common Error Messages

401 Unauthorized

"Missing or invalid API key."
Make sure you're including your API key in the api-key header. Example:
​api-key: sk_live_yourkeyhere

403 Forbidden

"You do not have access to this resource."
Your API key is valid but doesn’t have permission to access the requested data (e.g. wrong company or organization).

500 Internal Server Error

"Something went wrong on our end."
Unexpected issue on the server. Try again later. If the problem persists, contact support@claimlane.com.

Did this answer your question?