---
agentTools:
  projectIndex: https://docs.nvecta.com/llms.txt
---

# Event API

# 📊 Events Timeseries Report API

**Endpoint**:\
`https://reports-api.notifyvisitors.com/api_in/v1/get_event`

**Method**: `POST`

## 🧾 Overview

This API provides date-wise breakdowns of event metrics (e.g., total events, unique users, unique sessions) across a given time range. The data can be aggregated by **daily, weekly, monthly**, or **annual** intervals, and supports powerful filters based on event properties.

***

## 📥 Request Parameters

| Field            | Type     | Required | Description                                                                            |
| ---------------- | -------- | -------- | -------------------------------------------------------------------------------------- |
| `fromDate`       | `string` | ✅ Yes    | Start date in `YYYY-MM-DD` format.                                                     |
| `toDate`         | `string` | ✅ Yes    | End date in `YYYY-MM-DD` format.                                                       |
| `timeseries`     | `string` | ❌ No     | Interval for data breakdown: `daily`, `weekly`, `monthly`, `annual`. Default: `daily`. |
| `trend_metric`   | `string` | ✅ Yes    | Metric to analyze: `total_events`, `unique_users`, `unique_sessions`.                  |
| `event_name`     | `string` | ✅ Yes    | Name of the event to analyze.                                                          |
| `event_property` | `array`  | ❌ No     | List of filters on event properties. See below for format.                             |

***

### 🔎 Event Property Filter Format

Each object in `event_property` should include:

| Field      | Description                                                                                                                                                                              |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key`      | Event attribute (e.g., `Attributes - name`, `browser`) .Pass custom attributes as `Attributes - attribute_name` For system attributes details info see below table                       |
| `operator` | Filter condition. Supported values:<br> `Include`, `Exclude`, `Contains`, `Not contains`, `Is exist`, `Is one of`, `Is none of`, `Less than`, `Greater than`, `Range`, `Equals to`, `Is` |
| `value`    | Filter value(s). Can be strings, booleans, numbers, or arrays (e.g., `["Chrome", "Firefox"]`)                                                                                            |

<br />

***

## 🧰 System Attributes Reference (Display Name → System Key)

These attributes can be used `key` parameter inside the `event_property` array in the [Events Timeseries Report API](#📊-events-timeseries-report-api).

***

### 🎯 UTM Parameters

| Display Name | System Key           |
| ------------ | -------------------- |
| UTM Source   | `UTM - utm_source`   |
| UTM Medium   | `UTM - utm_medium`   |
| UTM Campaign | `UTM - utm_campaign` |
| UTM Content  | `UTM - utm_content`  |
| UTM Term     | `UTM - utm_term`     |
| UTM Adgroup  | `UTM - utm_adgroup`  |

### 🌍 Location

| Display Name   | System Key             |
| -------------- | ---------------------- |
| Country        | `country`              |
| City           | `city`                 |
| State          | `state`                |
| Continent Code | `Geo - continent_code` |
| Region Code    | `Geo - region_code`    |

### 📈 Conversion

| Display Name     | System Key                |
| ---------------- | ------------------------- |
| Channel          | `Conversion - channel`    |
| Campaign ID      | `Conversion - channel_id` |
| Attribution Type | `Conversion - attr`       |

### 🚦 Traffic

| Display Name           | System Key     |
| ---------------------- | -------------- |
| Platform               | `platform`     |
| Screen Name            | `screen_name`  |
| IP Address             | `ip_address`   |
| Integration Channel    | `channel`      |
| Traffic Source         | `organic`      |
| Search Engine          | `searchengine` |
| Referral Source        | `linkreferrer` |
| Operating System       | `os`           |
| Browser                | `browser`      |
| PWA / TWA              | `ispwa`        |
| Referral Source (User) | `referrer_url` |

### 📲 App

| Display Name          | System Key    |
| --------------------- | ------------- |
| App Version           | `app_version` |
| SDK Version           | `sdk_version` |
| Google Advertising ID | `ga_id`       |
| iOS Advertising ID    | `ios_ifa`     |

### 📄 Page / Session

| Display Name       | System Key                |
| ------------------ | ------------------------- |
| Page URL           | `pageurl`                 |
| Time Spent on Site | `session_timespent_float` |
| Page Views         | `session_pageviews_float` |

### 🛠️ Device Info

| Display Name      | System Key                        |
| ----------------- | --------------------------------- |
| Manufacturer      | `Device_info - manufacturer`      |
| Model             | `Device_info - model`             |
| Carrier           | `Device_info - carrier`           |
| Network Type      | `Device_info - network_type`      |
| WiFi Enabled      | `Device_info - wifi_enabled`      |
| Bluetooth Version | `Device_info - bluetooth_ver`     |
| Bluetooth Enabled | `Device_info - bluetooth_enabled` |

### 🧠 Computed Attributes

| Display Name      | System Key          |
| ----------------- | ------------------- |
| Preferred Channel | `Preferred_channel` |

### 🧩 Miscellaneous (Other)

| Display Name | System Key |
| ------------ | ---------- |
| Language     | `lang`     |
| Timezone     | `timezone` |
| Day          | `day`      |

## System Events Names

Below table contains system event names for events API

| System Event            |                         |
| ----------------------- | ----------------------- |
| Banner\_App\_Clicked    | Banner\_App\_Impression |
| Banner\_Clicked         | Banner\_Impression      |
| Email\_Bounced          | Email\_Clicked          |
| Email\_Delivered        | Email\_Opened           |
| Email\_Rejected         | Email\_Reply            |
| Email\_Sent             | Email\_Unsubscribe      |
| Form\_Impression        | Form\_Submission        |
| NPS\_Activity           | NPS\_App\_Activity      |
| NPS\_App\_Impression    | NPS\_Impression         |
| Push\_Clicked           | Push\_Delivered         |
| Push\_Dismissed         | Push\_Registered        |
| Push\_Unregistered      | SMS\_Bounced            |
| SMS\_Clicked            | SMS\_Delivered          |
| SMS\_Rejected           | SMS\_Sent               |
| Survey\_App\_Impression | Survey\_Impression      |
| Whatsapp\_Clicked       | Whatsapp\_Delivered     |
| Whatsapp\_Read          | Whatsapp\_Sent          |
| Whatsapp\_Unsubscribed  |                         |

<br />

## 📦 Sample Request

```json
{
  "brandID": "8194",
  "fromDate": "2024-08-01",
  "toDate": "2024-08-31",
  "timeseries": "daily",
  "trend_metric": "unique_users",
  "event_name": "vaar",
  "event_property": [
    {
      "key": "Attributes - name",
      "operator": "Is Exist",
      "value": "No"
    }
  ]
}
```

***

## 📤 Sample Response

```json
{
  "status_code": 200,
  "message": "success",
  "response": {
    "data": {
      "2024-08-01": 10,
      "2024-08-02": 4,
      "2024-08-03": 9,
      ...
      "2024-08-31": 0
    },
    "totalCount": 64
  }
}
```

### ✅ Response Fields:

* `data`: Object with date keys and count values.
* `totalCount`: Sum of the counts over the selected time period.
* <br />

## API Rate Limit

* The API rate limit is the number of time the API can be requested per minute.
* You can make up to 500 API requests per minute on an API.
* If the limit exceeds, the app will throw error in Response. All API requests are subject to rate limits.