Humblytics

https://docs.humblytics.com
Admin
Humblytics is an all-in-one conversion rate optimization platform combining A/B testing, heatmaps,...
Tokens:104,747
Snippets:1,068
Trust Score:8.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example API Request for Documentation Query

Source: https://docs.humblytics.com/how-to-get-started/bolt

This example shows how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter. Replace <question> with your specific query.

```http
GET https://docs.humblytics.com/how-to-get-started/bolt.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://docs.humblytics.com/how-to-get-started/ghost-cms

Example of how to query the documentation dynamically using the 'ask' query parameter for additional information.

```http
GET https://docs.humblytics.com/how-to-get-started/ghost-cms.md?ask=<question>
```

--------------------------------

### Query Documentation via GET Request

Source: https://docs.humblytics.com/how-to-get-started/add-humblytics-analytics-to-a-custom-self-hosted-site

Use this GET request to ask a specific question about the documentation. Append your question to the 'ask' parameter.

```http
GET https://docs.humblytics.com/how-to-track-custom-click-events/how-to-track-click-events-on-custom-self-hosted-site.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.humblytics.com/how-to-track-custom-form-submissions/hubspot-forms/custom-self-hosted-how-to-track-hubspot-form-submissions

To get additional information not explicitly present on the page, you can query the documentation dynamically. Perform an HTTP GET request to the page URL with the 'ask' query parameter, followed by your specific question.

```http
GET https://docs.humblytics.com/how-to-track-custom-form-submissions/hubspot-forms/custom-self-hosted-how-to-track-hubspot-form-submissions.md?ask=<question>
```

--------------------------------

### Querying Documentation via GET Request

Source: https://docs.humblytics.com/how-to-get-started/google-tag-manager

Use this GET request format to ask questions about the documentation and receive direct answers with relevant excerpts.

```http
GET https://docs.humblytics.com/how-to-get-started/google-tag-manager.md?ask=<question>
```

--------------------------------

### Query Documentation via GET Request

Source: https://docs.humblytics.com/how-to-track-custom-form-submissions/typeform/webflow-how-to-track-typeform-submissions

To get additional information not directly present on the page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.humblytics.com/how-to-track-custom-form-submissions/typeform/webflow-how-to-track-typeform-submissions.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/split-testing-overview/creating-a-b-page-variants-for-split-testing/engagement-goals/increase-session-time

To get more information not directly on the page, make an HTTP GET request to the current URL with an 'ask' query parameter. The response will include a direct answer and relevant documentation excerpts.

```http
GET https://docs.humblytics.com/split-testing-overview/creating-a-b-page-variants-for-split-testing/engagement-goals/increase-session-time.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.humblytics.com/how-to-track-purchase-events/stripe/stripe-api

To get more information not present on the current page, make an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```bash
GET https://docs.humblytics.com/how-to-track-purchase-events/stripe/stripe-api.md?ask=<question>
```

--------------------------------

### Deploy Astro Project to Production

Source: https://docs.humblytics.com/how-to-get-started/astro

Example deployment commands for popular hosting platforms like Vercel and Netlify.

```bash
vercel --prod
```

```bash
netlify deploy --prod
```

--------------------------------

### Run Astro Development Server

Source: https://docs.humblytics.com/how-to-get-started/astro

Start the local development server for your Astro project using npm.

```bash
npm run dev
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.humblytics.com/split-testing-overview/how-humblytics-split-testing-works-under-the-hood

To get more information not present on the current page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```HTTP
GET https://docs.humblytics.com/split-testing-overview/how-humblytics-split-testing-works-under-the-hood.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.humblytics.com/how-to-get-started/react-router

To get additional information not explicitly present on the page, make a GET request to the documentation URL with the 'ask' query parameter. The question should be specific and in natural language.

```bash
GET https://docs.humblytics.com/how-to-get-started/react-router.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.humblytics.com/split-testing-overview/creating-a-b-page-variants-for-split-testing/conversion-goals/increase-form-submissions

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```bash
GET https://docs.humblytics.com/split-testing-overview/creating-a-b-page-variants-for-split-testing/conversion-goals/increase-form-submissions.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/export-data

To get information not directly present on a page, make an HTTP GET request with an 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://docs.humblytics.com/export-data.md?ask=<question>
```

--------------------------------

### Querying Documentation API

Source: https://docs.humblytics.com/connectors

Use this GET request to ask questions about the documentation. Replace <question> with your specific query.

```bash
GET https://docs.humblytics.com/connectors.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/agent-onboarding-api

To get more information not present on the current page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language. This is useful for clarifications or retrieving related documentation.

```HTTP
GET https://docs.humblytics.com/agent-onboarding-api.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/how-to-get-started/replit

To get additional information not present on the current page, make an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language.

```bash
GET https://docs.humblytics.com/how-to-get-started/replit.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.humblytics.com/understanding-your-data/understanding-locations-data

To get additional information not directly present on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.humblytics.com/understanding-your-data/understanding-locations-data.md?ask=<question>
```

--------------------------------

### API for Dynamic Documentation Query

Source: https://docs.humblytics.com/how-to-track-custom-form-submissions/tally.so/framer-how-to-track-tally.so-form-submissions

To get more information not present on the page, make a GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://docs.humblytics.com/how-to-track-custom-form-submissions/tally.so/framer-how-to-track-tally.so-form-submissions.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/ai-chat

To get information not directly present on a page, make an HTTP GET request to the page URL with an 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.humblytics.com/ai-chat.md?ask=<question>
```

--------------------------------

### Querying Documentation with `ask` Parameter

Source: https://docs.humblytics.com/how-to-track-custom-form-submissions/cal.com

To get specific information not found directly on a page, make a GET request to the page URL with the `ask` query parameter. This allows for dynamic querying of documentation content.

```HTTP
GET https://docs.humblytics.com/how-to-track-custom-form-submissions/cal.com.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.humblytics.com/split-testing-overview/creating-a-b-page-variants-for-split-testing/conversion-goals/increase-revenue

To get additional information not directly present on the page, make an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```HTTP
GET https://docs.humblytics.com/split-testing-overview/creating-a-b-page-variants-for-split-testing/conversion-goals/increase-revenue.md?ask=<question>
```

--------------------------------

### Get Split Test Recommendations

Source: https://docs.humblytics.com/split-testing-api

Fetches optimization recommendations for a specific page. This is the first step before creating any split tests.

```HTTP
GET /properties/prop_abc123/split-test-recommendations?page=/home
```

--------------------------------

### Get Page Details

Source: https://docs.humblytics.com/split-testing-api

Retrieve detailed analytics for a specific page within a property, including start and end dates.

```http
GET /properties/{propertyId}/pages/details?page={path}&start={date}&end={date}
```

--------------------------------

### Get Forms Details

Source: https://docs.humblytics.com/split-testing-api

Retrieve detailed form analytics for a specific page within a property, including start and end dates.

```http
GET /properties/{propertyId}/forms/details?page={path}&start={date}&end={date}
```

--------------------------------

### Get Clicks Details

Source: https://docs.humblytics.com/split-testing-api

Retrieve detailed click analytics for a specific page within a property, including start and end dates.

```http
GET /properties/{propertyId}/clicks/details?page={path}&start={date}&end={date}
```

--------------------------------

### Initiate Signup Session

Source: https://docs.humblytics.com/agent-onboarding-api

Call this endpoint to create a signup session for a new user and obtain a verification URL. The request body must include the user's email and name.

```bash
curl -X POST https://app.humblytics.com/api/v1/auth/agent-initiate \
  -H "Content-Type: application/json" \
  -d '{ "email": "user@example.com", "name": "Jane Smith" }'
```

--------------------------------

### GET Funnels Sankey Request

Source: https://docs.humblytics.com/external-analytics-api

Retrieve path flow data for a funnel in Sankey diagram format. Use query parameters like `start`, `end`, `steps`, `mode`, `maxPaths`, and `minSessions` to customize the request.

```bash
curl \
  -H "Authorization: Bearer $HUMBLYTICS_API_KEY" \
  "https://app.humblytics.com/api/external/v1/properties/PROPERTY_ID/funnels/sankey?start=2024-05-01&end=2024-05-31&timezone=UTC&steps=%5B%7B%22page%22%3A%22%2F%22%7D%2C%7B%22page%22%3A%22%2Fpricing%22%7D%2C%7B%22page%22%3A%22%2Fsignup%22%7D%5D&mode=sequential&maxPaths=10&minSessions=5"
```

--------------------------------

### Initiate Agent Signup

Source: https://docs.humblytics.com/agent-onboarding-api

Creates a signup session for a new user, returning a verification URL and session token.

```APIDOC
## POST /api/v1/auth/agent-initiate

### Description
Creates a signup session for a new user.

### Method
POST

### Endpoint
https://app.humblytics.com/api/v1/auth/agent-initiate

### Parameters
#### Request Body
- **email** (string) - Required - User's email address
- **name** (string) - Required - User's full name

### Request Example
```json
{
  "email": "user@example.com",
  "name": "Jane Smith"
}
```

### Response
#### Success Response (201)
- **token** (string) - Session token for verification
- **verifyUrl** (string) - URL for the user to complete verification
- **expiresAt** (integer) - Timestamp when the session expires

#### Response Example
```json
{
  "token": "<session-token>",
  "verifyUrl": "https://app.humblytics.com/agent-verify?token=<session-token>",
  "expiresAt": 1234567890000
}
```

### Error Responses
- **409 Conflict**: `{ "error": "user_exists" }` - Email already has an account
- **400 Bad Request**: `{ "error": "invalid_email" }` - Email format is invalid
```

--------------------------------

### Get Clicks Breakdown

Source: https://docs.humblytics.com/split-testing-api

Get a breakdown of click data for a property within a specified date range.

```http
GET /properties/{propertyId}/clicks/breakdown?start={date}&end={date}
```

--------------------------------

### Get Forms Breakdown

Source: https://docs.humblytics.com/split-testing-api

Get a breakdown of form submission data for a property within a specified date range.

```http
GET /properties/{propertyId}/forms/breakdown?start={date}&end={date}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/how-to-get-started

Use this method to ask specific questions about the documentation. The response includes a direct answer and relevant excerpts.

```bash
GET https://docs.humblytics.com/how-to-get-started.md?ask=<question>
```

--------------------------------

### Get Pages Breakdown

Source: https://docs.humblytics.com/split-testing-api

Get a breakdown of page performance data for a property within a specified date range.

```http
GET /properties/{propertyId}/pages/breakdown?start={date}&end={date}
```

--------------------------------

### Get Funnel Suggestions

Source: https://docs.humblytics.com/split-testing-api

Get funnel suggestions for a specific page within a property. This endpoint does not require date parameters.

```http
GET /properties/{propertyId}/funnels/suggestions?page={path}
```

--------------------------------

### Dynamic Documentation Query

Source: https://docs.humblytics.com/cross-domain-tracking-and-whitelisting

Use this GET request to ask specific questions about the documentation. The 'ask' parameter should contain a clear, natural language question.

```http
GET https://docs.humblytics.com/cross-domain-tracking-and-whitelisting.md?ask=<question>
```

--------------------------------

### Sample Response for Listing Meta Ads Connections

Source: https://docs.humblytics.com/ads-connections-api

Example JSON response when listing Meta Ads connections. It includes connection details and associated ad accounts.

```json
{
  "connections": [
    {
      "id": "4a20c9a9-d027-4cab-9130-28c05d00e72c",
      "propertyId": "PROPERTY_ID",
      "userId": null,
      "metaUserId": "122096569802691382",
      "metaUserEmail": null,
      "metaUserName": "Humblytics System User",
      "adAccounts": [
        {
          "id": "act_1841530576550922",
          "name": "Humblytics Ads",
          "currency": "CAD",
          "timezone": "America/Toronto",
          "isActive": true
        }
      ],
      "createdAt": "2026-04-15T16:21:59.948Z",
      "updatedAt": "2026-04-15T16:21:59.948Z",
      "lastSyncAt": null,
      "tokenExpiresAt": null,
      "syncState": null
    }
  ]
}
```

--------------------------------

### Get Traffic Breakdown

Source: https://docs.humblytics.com/split-testing-api

Get a breakdown of traffic data for a property within a specified date range, with an optional limit for the number of results.

```http
GET /properties/{propertyId}/traffic/breakdown?start={date}&end={date}&limit=20
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.humblytics.com/how-to-track-custom-form-submissions/hubspot-booking-links

Use this method to ask specific questions about the documentation. The response includes direct answers and relevant excerpts.

```HTTP
GET https://docs.humblytics.com/how-to-track-custom-form-submissions/hubspot-booking-links.md?ask=<question>
```

--------------------------------

### Verify Environment

Source: https://docs.humblytics.com/how-to-get-started/laravel

Use this command to verify the current environment settings.

```bash
php artisan env
```

--------------------------------

### Build and Preview Production Astro Site

Source: https://docs.humblytics.com/how-to-get-started/astro

Commands to build your Astro project for production and test it locally before deploying.

```bash
npm run build
npm run preview  # Test production build locally
```

--------------------------------

### React Client-Side Purchase Event Tracking

Source: https://docs.humblytics.com/how-to-track-purchase-events/other-providers

This React example demonstrates how to track revenue using `useEffect` on a client-side confirmation page. It ensures the `trackRevenue` function is called with the correct amount and currency after the order details are available.

```jsx
"use client";

import { useEffect } from "react";

export default function Confirmation({ order }) {
  useEffect(() => {
    if (!order) return;

    const amountInCents = Math.round(order.total * 100);
    window.Humblytics.trackRevenue(amountInCents, order.currency);
  }, [order]);

  return (
    <div>
      <h1>Thanks for your purchase!</h1>
    </div>
  );
}
```

--------------------------------

### Initiate Agent Signup

Source: https://docs.humblytics.com/agent-onboarding-api

Initiates the agent signup process.

```APIDOC
## POST /api/v1/auth/agent-initiate

### Description
Initiates the agent signup process.

### Method
POST

### Endpoint
/api/v1/auth/agent-initiate
```

--------------------------------

### Perform HTTP GET Request with 'ask' Parameter

Source: https://docs.humblytics.com/how-to-get-started/squarespace

Use this method to query documentation dynamically by appending the 'ask' query parameter with your question to the page URL.

```http
GET https://docs.humblytics.com/how-to-get-started/squarespace.md?ask=<question>
```

--------------------------------

### Query Documentation with `ask` Parameter

Source: https://docs.humblytics.com/how-to-get-started/webflow

Use this method to retrieve specific answers, clarifications, or related documentation sections when information is not explicitly present on the current page. The question should be specific and self-contained.

```http
GET https://docs.humblytics.com/how-to-get-started/webflow.md?ask=<question>
```

--------------------------------

### Get Billing Status

Source: https://docs.humblytics.com/agent-onboarding-api

Retrieves the current billing status for the account.

```APIDOC
## GET /api/v1/billing/status

### Description
Retrieves the billing status.

### Method
GET

### Endpoint
/api/v1/billing/status
```

--------------------------------

### GET /properties/{propertyId}/saved-funnels

Source: https://docs.humblytics.com/external-analytics-api

Returns all saved funnel configurations for the property.

```APIDOC
## GET /properties/{propertyId}/saved-funnels

### Description
Returns all saved funnel configurations for the property.

### Method
GET

### Endpoint
/properties/{propertyId}/saved-funnels

### Request Example
```bash
curl \
  -H "Authorization: Bearer $HUMBLYTICS_API_KEY" \
  "https://app.humblytics.com/api/external/v1/properties/PROPERTY_ID/saved-funnels"
```

### Response
#### Success Response (200)
- **data** (array)
  - **id** (string)
  - **name** (string)
  - **steps** (array of objects)
    - **page** (string)
  - **created_at** (string)

#### Response Example
```json
{
  "data": [
    {
      "id": "funnel_abc123",
      "name": "Homepage to Signup",
      "steps": [
        { "page": "/" },
        { "page": "/pricing" },
        { "page": "/signup" }
      ],
      "created_at": "2024-05-01T10:00:00.000Z"
    }
  ]
}
```
```

--------------------------------

### GET List Saved Funnels Request

Source: https://docs.humblytics.com/external-analytics-api

Retrieve all saved funnel configurations for a property.

```bash
curl \
  -H "Authorization: Bearer $HUMBLYTICS_API_KEY" \
  "https://app.humblytics.com/api/external/v1/properties/PROPERTY_ID/saved-funnels"
```

--------------------------------

### Add Website to Account

Source: https://docs.humblytics.com/agent-onboarding-api

After obtaining an auth token, use this endpoint to add a new website to the user's account. The request requires the Authorization header with the Bearer token and a JSON body containing the domain and name of the site.

```bash
curl -X POST https://app.humblytics.com/api/v1/add-custom-site \
  -H "Authorization: Bearer <authToken>" \
  -H "Content-Type: application/json" \
  -d '{ "domain": "example.com", "name": "My Site" }'
```

--------------------------------

### Get Split Test Details

Source: https://docs.humblytics.com/split-testing-api

Returns full experiment details including per-variant metrics.

```APIDOC
## GET /properties/{propertyId}/split-tests/{experimentId}

### Description
Returns full experiment details including per-variant metrics.

### Method
GET

### Endpoint
/properties/{propertyId}/split-tests/{experimentId}

### Request Example
```bash
curl \
  -H "Authorization: Bearer $HUMBLYTICS_API_KEY" \
  "https://app.humblytics.com/api/external/v1/properties/PROPERTY_ID/split-tests/exp_xyz789"
```

### Response
#### Success Response (200)
- **experiment_id** (string) - The ID of the experiment.
- **name** (string) - The name of the experiment.
- **page** (string) - The page where the experiment is running.
- **status** (string) - The current status of the experiment.
- **goal** (string) - The conversion goal for the experiment.
- **created_at** (string) - The timestamp when the experiment was created.
- **auto_stop_days** (number) - The number of days after which the experiment will automatically stop.
- **variants** (array) - An array of variant objects.
  - **label** (string) - The label for the variant.
  - **is_control** (boolean) - Indicates if this variant is the control group.
  - **sessions** (integer) - The number of sessions for this variant.
  - **conversions** (integer) - The number of conversions for this variant.
  - **conversion_rate** (number) - The conversion rate for this variant (e.g., 0.166).
  - **changes** (array) - An array of changes applied in this variant.
    - **selector** (string) - The CSS selector for the change.
    - **op** (string) - The operation performed (e.g., `text`, `css`).
    - **value** (string or object) - The value applied by the operation.

#### Response Example
```json
{
  "experiment_id": "exp_xyz789",
  "name": "Hero CTA Optimization",
  "page": "/home",
  "status": "active",
  "goal": "click_through",
  "created_at": "2026-03-27T10:00:00.000Z",
  "auto_stop_days": 14,
  "variants": [
    {
      "label": "Control",
      "is_control": true,
      "sessions": 1523,
      "conversions": 198,
      "conversion_rate": 0.13,
      "changes": []
    },
    {
      "label": "Variant B — new copy + color",
      "is_control": false,
      "sessions": 1489,
      "conversions": 247,
      "conversion_rate": 0.166,
      "changes": [
        { "selector": "button.hero-cta", "op": "text", "value": "Start Free Trial" },
        { "selector": "button.hero-cta", "op": "css", "value": { "backgroundColor": "#ff6b35" } }
      ]
    }
  ]
}
```

### Notes
* Per-variant metrics (`sessions`, `conversions`, `conversion_rate`) are returned so you can programmatically evaluate experiment performance.
* `conversion_rate` is a decimal (e.g. `0.166` = 16.6%).
```

--------------------------------

### Get Funnel Suggestions

Source: https://docs.humblytics.com/split-testing-api

Retrieves suggestions for funnel creation based on a specific page within a property.

```APIDOC
## GET /properties/{propertyId}/funnels/suggestions

### Description
Retrieves suggestions for funnel creation based on a specific page.

### Method
GET

### Endpoint
/properties/{propertyId}/funnels/suggestions

### Parameters
#### Path Parameters
- **propertyId** (string) - Required - The ID of the property.

#### Query Parameters
- **page** (string) - Required - The path of the page for which to get funnel suggestions.
```

--------------------------------

### Add Website

Source: https://docs.humblytics.com/agent-onboarding-api

Adds a new website to the user's account using the provided authentication token.

```APIDOC
## POST /api/v1/add-custom-site

### Description
Adds a website to the account and returns property and script IDs.

### Method
POST

### Endpoint
https://app.humblytics.com/api/v1/add-custom-site

### Parameters
#### Request Body
- **domain** (string) - Required - The domain name of the website
- **name** (string) - Required - A display name for the website

### Request Example
```json
{
  "domain": "example.com",
  "name": "My Site"
}
```

### Response
#### Success Response (200)
- **propertyId** (string) - The unique identifier for the added property
- **scriptId** (string) - The ID to be used in the tracking script

#### Response Example
```json
{
  "propertyId": "<property-id>",
  "scriptId": "<script-id>"
}
```
```
Tokens:
Raw