# API Builder

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

<figure><img src="https://2350286830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6Yw9IRJ6KbbucQPwZUCZ%2Fuploads%2FuecdI02Jbwtwi6c77qIb%2Fimage.png?alt=media&#x26;token=d4b23dbd-3977-4e73-bfc0-c8894be6fe32" 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="https://2350286830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6Yw9IRJ6KbbucQPwZUCZ%2Fuploads%2FVNGPAvzNeCqeyLA2z5PZ%2Fimage.png?alt=media&#x26;token=89544ca3-3142-47f1-be0d-11f5876d1834" 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="https://2350286830-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F6Yw9IRJ6KbbucQPwZUCZ%2Fuploads%2FEfMhi9ezafvWjiUQQpdJ%2Fimage.png?alt=media&#x26;token=86958ec6-e2d8-4906-a805-547eb44b890e" 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 %}