Event Overview

Return event totals, a comparison against the previous period, and a timeline.

curl -X GET "https://api.hardal.ai/v1/reports/events/overview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&metricEventNames=%5B%22John%20Doe%22%5D&timelineEventNames=%5B%22John%20Doe%22%5D&timelineOptionMode=include&conversionEventNames=%5B%22John%20Doe%22%5D&metricsOnly=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://api.hardal.ai/v1/reports/events/overview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&metricEventNames=%5B%22John%20Doe%22%5D&timelineEventNames=%5B%22John%20Doe%22%5D&timelineOptionMode=include&conversionEventNames=%5B%22John%20Doe%22%5D&metricsOnly=true"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.hardal.ai/v1/reports/events/overview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&metricEventNames=%5B%22John%20Doe%22%5D&timelineEventNames=%5B%22John%20Doe%22%5D&timelineOptionMode=include&conversionEventNames=%5B%22John%20Doe%22%5D&metricsOnly=true", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.hardal.ai/v1/reports/events/overview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&metricEventNames=%5B%22John%20Doe%22%5D&timelineEventNames=%5B%22John%20Doe%22%5D&timelineOptionMode=include&conversionEventNames=%5B%22John%20Doe%22%5D&metricsOnly=true", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.hardal.ai/v1/reports/events/overview?tenantId=123e4567-e89b-12d3-a456-426614174000&sourceId=123e4567-e89b-12d3-a456-426614174000&timeframe=today&startDate=example_string&endDate=example_string&timezone=example_string&interval=minute&metricEventNames=%5B%22John%20Doe%22%5D&timelineEventNames=%5B%22John%20Doe%22%5D&timelineOptionMode=include&conversionEventNames=%5B%22John%20Doe%22%5D&metricsOnly=true')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "success": true,
  "data": {
    "range": {
      "startDate": "2026-10-01",
      "endDate": "2026-10-07",
      "timezone": "Europe/Istanbul"
    },
    "previousRange": {
      "startDate": "2026-09-24",
      "endDate": "2026-09-30",
      "timezone": "Europe/Istanbul"
    },
    "interval": "day",
    "metrics": {
      "totalEvents": {
        "current": 25200,
        "previous": 21750
      },
      "keyEvents": {
        "current": 630,
        "previous": 540
      },
      "pageViews": {
        "current": 9660,
        "previous": 8250
      },
      "eventsPerVisitor": {
        "current": 13.6957,
        "previous": 13.5938
      },
      "eventsPerSession": {
        "current": 6,
        "previous": 5.8
      }
    },
    "timeline": [
      {
        "timestamp": "2026-10-01 00:00:00",
        "eventName": "page_view",
        "eventCount": 1196
      },
      {
        "timestamp": "2026-10-01 00:00:00",
        "eventName": "form_submit",
        "eventCount": 26
      },
      {
        "timestamp": "2026-10-02 00:00:00",
        "eventName": "page_view",
        "eventCount": 1380
      },
      {
        "timestamp": "2026-10-02 00:00:00",
        "eventName": "form_submit",
        "eventCount": 30
      },
      {
        "timestamp": "2026-10-03 00:00:00",
        "eventName": "page_view",
        "eventCount": 1472
      },
      {
        "timestamp": "2026-10-03 00:00:00",
        "eventName": "form_submit",
        "eventCount": 32
      },
      {
        "timestamp": "2026-10-04 00:00:00",
        "eventName": "page_view",
        "eventCount": 1380
      },
      {
        "timestamp": "2026-10-04 00:00:00",
        "eventName": "form_submit",
        "eventCount": 30
      },
      {
        "timestamp": "2026-10-05 00:00:00",
        "eventName": "page_view",
        "eventCount": 1518
      },
      {
        "timestamp": "2026-10-05 00:00:00",
        "eventName": "form_submit",
        "eventCount": 33
      },
      {
        "timestamp": "2026-10-06 00:00:00",
        "eventName": "page_view",
        "eventCount": 1518
      },
      {
        "timestamp": "2026-10-06 00:00:00",
        "eventName": "form_submit",
        "eventCount": 33
      },
      {
        "timestamp": "2026-10-07 00:00:00",
        "eventName": "page_view",
        "eventCount": 1196
      },
      {
        "timestamp": "2026-10-07 00:00:00",
        "eventName": "form_submit",
        "eventCount": 26
      }
    ],
    "timelineEventOptions": [
      {
        "eventName": "page_view",
        "eventLabel": "page_view",
        "eventCount": 9660
      },
      {
        "eventName": "form_submit",
        "eventLabel": "form_submit",
        "eventCount": 210
      }
    ]
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-required",
    "message": "tenant-required"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "validation-error",
    "message": "Validation failed for 'timeframe': timeframe must be one of: today, yesterday, last7days, last30days, custom",
    "details": {
      "field": "timeframe",
      "message": "timeframe must be one of: today, yesterday, last7days, last30days, custom"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "bearer-required",
    "message": "bearer-required"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "invalid-credential",
    "message": "invalid-credential"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "credential-revoked",
    "message": "credential-revoked"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "credential-expired",
    "message": "credential-expired"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-not-granted",
    "message": "tenant-not-granted",
    "details": {
      "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "source-does-not-belong-to-tenant",
    "message": "source-does-not-belong-to-tenant"
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "insufficient-scope",
    "message": "insufficient-scope",
    "details": {
      "required": "reports:read"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "tenant-not-found",
    "message": "tenant-not-found",
    "details": {
      "tenantId": "2f1c7c3e-6c1a-4f1e-9b7a-2d8e4c1a9f10"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "source-not-found",
    "message": "source-not-found",
    "details": {
      "sourceId": "7b0e5a54-1d43-4c8e-8d2f-5a9c3e6b1f27"
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

{
  "success": false,
  "error": {
    "code": "rate-limited",
    "message": "rate-limited",
    "details": {
      "retryAfterSeconds": 30
    }
  },
  "timestamp": "2026-11-01T09:30:00.000Z",
  "path": "/v1/reports/events/overview",
  "requestId": "req_01JD2V8Q9Z6R4XK7T3M5N8P2WA"
}

GET

/v1/reports/events/overview

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

OAuth access token (token exchange) or organization API key.

query

tenantIdstring

Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

Format: uuid

query

sourceIdstring

UUID of one source of the tenant. Omit it to include every source of the tenant.

Format: uuid

query

timeframestring

Reporting period. The presets today, yesterday, last7days and last30days cover whole calendar days ending today in the request timezone; last7days is today and the six days before it. Use custom together with startDate and endDate. Defaults to today.

query

startDatestring

First day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom, together with endDate.

Min length: 10 • Max length: 10 • Pattern: ^\d{4}-\d{2}-\d{2}$

query

endDatestring

Last day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom; it must not be before startDate.

Min length: 10 • Max length: 10 • Pattern: ^\d{4}-\d{2}-\d{2}$

query

timezonestring

IANA time zone name such as Europe/Istanbul or America/New_York. It sets the calendar-day boundaries of the period and of the time buckets. Defaults to Europe/Istanbul.

Min length: 1 • Max length: 100

query

intervalstring

Bucket size of timeline. Defaults to a size that fits the period: hour up to one day, day up to 14 days, week up to 90 days, otherwise month.

query

metricEventNamesarray

Limit the metric cards to these event names, up to 50. Repeat the parameter or separate names with commas. Defaults to all events. The timeline is not affected.

query

timelineEventNamesarray

Event names to keep in or remove from timeline, up to 50. Requires timelineOptionMode.

query

timelineOptionModestring

include keeps only timelineEventNames in the timeline; exclude removes them. Requires timelineEventNames.

query

conversionEventNamesarray

Event names counted as keyEvents. Defaults to the tenant's conversion events.

query

metricsOnlystring

true returns only the metric cards and leaves timeline and timelineEventOptions empty. Defaults to false.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. OAuth access token (token exchange) or organization API key.

Query Parameters

tenantIdstring

Required

UUID of the tenant to report on. Send it exactly once. GET /v1/workspace/access lists the tenants this credential can read.

sourceIdstring

UUID of one source of the tenant. Omit it to include every source of the tenant.

timeframestring

startDatestring

First day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom, together with endDate.

endDatestring

Last day of a custom period, YYYY-MM-DD, inclusive. Send it only with timeframe=custom; it must not be before startDate.

timezonestring

IANA time zone name such as Europe/Istanbul or America/New_York. It sets the calendar-day boundaries of the period and of the time buckets. Defaults to Europe/Istanbul.

intervalstring

Bucket size of timeline. Defaults to a size that fits the period: hour up to one day, day up to 14 days, week up to 90 days, otherwise month.

metricEventNamesarray

Limit the metric cards to these event names, up to 50. Repeat the parameter or separate names with commas. Defaults to all events. The timeline is not affected.

timelineEventNamesarray

Event names to keep in or remove from timeline, up to 50. Requires timelineOptionMode.

timelineOptionModestring

include keeps only timelineEventNames in the timeline; exclude removes them. Requires timelineEventNames.

conversionEventNamesarray

Event names counted as keyEvents. Defaults to the tenant's conversion events.

metricsOnlystring

true returns only the metric cards and leaves timeline and timelineEventOptions empty. Defaults to false.

Responses

successboolean

Required

Allowed values:true

dataobject

Required

timestampstring

Required

pathstring

Required

requestIdstring

Required

Was this page helpful?