> For the complete documentation index, see [llms.txt](https://docs.abtasty.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.abtasty.com/adaptivecx/getting-started/activate/integrations/api-builder.md).

# API Builder

Access AdaptiveCX data through server-side APIs for custom integrations, data export, and analysis.

<figure><img src="/files/x8FeQwZ7ZRrxYj1X2WKg" alt=""><figcaption></figcaption></figure>

## What API Builder does <a href="#what-api-builder-does" id="what-api-builder-does"></a>

The API Builder provides programmatic access to your AdaptiveCX data:

* Raw Data: Export detailed visitor and session data
* Aggregated Data: Export summarized metrics for analytics
* Custom queries: Filter and group data for specific needs
* Real-time access: Retrieve data on demand via API

## Raw Data endpoint <a href="#raw-data-endpoint" id="raw-data-endpoint"></a>

<figure><img src="/files/G0tPfJ7GP5dNfGVDmE93" alt=""><figcaption></figcaption></figure>

Export detailed visitor and session data for granular analysis.

### Parameters <a href="#parameters" id="parameters"></a>

* Start Date: Beginning of date range (required)
* End Date: End of date range (required)
* Group By: Session ID, Visitor ID, or custom groupings
* Page Number: For paginated results
* Data to Show: Specific attributes and events to include

### Example request <a href="#example-request" id="example-request"></a>

```http
GET /platform-api/external/raw-data
  ?clientTag=YOUR_CLIENT_TAG
  &domain=yourdomain.com
  &token=YOUR_API_TOKEN
  &startDate=2024-01-01
  &endDate=2024-01-31
  &groupBy=sessionid
  &pageNumber=1
```

## Aggregated Data endpoint <a href="#aggregated-data-endpoint" id="aggregated-data-endpoint"></a>

<figure><img src="/files/5lhFBQHEp4ThxZJ7Ajge" alt=""><figcaption></figcaption></figure>

Export summarized metrics for analytics and reporting.

### API Types <a href="#api-types" id="api-types"></a>

* Daily Sessions: Session counts by day
* Unique Visitors: Visitor counts by day
* Event Counts: Event occurrence summaries
* Conversion Metrics: Goal completion data

### Parameters <a href="#parameters-1" id="parameters-1"></a>

* Start Date: Beginning of date range (required)
* End Date: End of date range (required)
* Timezone: Your timezone for accurate daily grouping
* Data Breakdown by: Domain or Subdomain

### Example request <a href="#example-request-1" id="example-request-1"></a>

```http
GET /platform-api/external/daily-sessions
  ?clientTag=YOUR_CLIENT_TAG
  &domain=yourdomain.com
  &token=YOUR_API_TOKEN
  &startDate=2024-02-27
  &endDate=2024-03-05
  &offset=0
```

## Authentication <a href="#authentication" id="authentication"></a>

The API Builder generates the request URL with your credentials automatically included:

```
https://app.wandz.ai/platform-api/external/raw-data
  ?clientTag=YOUR_CLIENT_TAG
  &domain=yourdomain.com
  &token=YOUR_API_TOKEN
  &startDate=2026-03-05
  &endDate=2026-03-05
  ...
```

The `clientTag` and `token` parameters are pre-populated in the API Request section. Copy this URL to use in your applications.

{% hint style="warning" %}
Keep your API token secure. Never expose it in client-side code, public repositories, or logs.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.abtasty.com/adaptivecx/getting-started/activate/integrations/api-builder.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.