# Event Tracker

{% hint style="success" %}
**- NEW! - Interactive API docs, now live!**

Visit [api-docs.plumvoice.com](https://api-docs.plumvoice.com/) to **read** Plum API documentation, **build and test requests** in our interactive API sandbox, **review** the responses, and **share** it all with your team.
{% endhint %}

## Event Tracker

<mark style="color:blue;">`GET`</mark> `https://voicetrends.plumvoice.com/api/events/{start}/{end}/{period}/{phone}`

This service fetches any of the available data in the Event Tracker section in VoiceTrends. To use this service, provide your temporary authentication credentials and several GET parameters, which function as filters for this data. This API is rate-limited in a group with all other raw data resources to 150 requests per 15-minute window.&#x20;

#### Path Parameters

| Name   | Type    | Description                                                                        |
| ------ | ------- | ---------------------------------------------------------------------------------- |
| start  | integer | The start date (inclusive) for this request in YYYYMMDD format.                    |
| end    | integer | The end date (inclusive) for this request in YYYYMMDD format.                      |
| period | string  | The period that the data will be grouped into (day, week, month).                  |
| phone  | string  | The single phone number for this report or “ALL” to merge data across all numbers. |

{% tabs %}
{% tab title="200 " %}
{% tabs %}
{% tab title="JSON" %}

```javascript
HTTP/1.1 200 OK
X-RateLimit-Limit: 150
X-RateLimit-Remaining: 149
X-RateLimit-Reset: 1519659900
Content-Length: 813
Content-Type: application/json

{
  "calls":{"1517461200":0,"1517547600":0,"1517634000":0,"1517720400":0,"1517806800":0,"1517893200":0,"1517979600":1,"1518066000":0},
  "log_events":{"1517461200":0,"1517547600":0,"1517634000":0,"1517720400":0,"1517806800":0,"1517893200":0,"1517979600":0,"1518066000":0},
  "loops_per_call":{"1517461200":0,"1517547600":0,"1517634000":0,"1517720400":0,"1517806800":0,"1517893200":0,"1517979600":0,"1518066000":0},
  "form_items":{"1517461200":0,"1517547600":0,"1517634000":0,"1517720400":0,"1517806800":0,"1517893200":0,"1517979600":0,"1518066000":0},
  "loops":{"1517461200":0,"1517547600":0,"1517634000":0,"1517720400":0,"1517806800":0,"1517893200":0,"1517979600":0,"1518066000":0},
  "average_form_items":{"1517461200":0,"1517547600":0,"1517634000":0,"1517720400":0,"1517806800":0,"1517893200":0,"1517979600":0,"1518066000":0}
}
```

{% endtab %}

{% tab title="XML" %}

```markup
HTTP/1.1 200 OK
X-RateLimit-Limit: 150
X-RateLimit-Remaining: 148
X-RateLimit-Reset: 1519659900
Content-Length: 1970
Content-Type: application/xml

<?xml version="1.0"?>
<result>
  <calls>
    <item timestamp="1517461200">0</item>
    <item timestamp="1517547600">0</item>
    <item timestamp="1517634000">0</item>
    <item timestamp="1517720400">0</item>
    <item timestamp="1517806800">0</item>
    <item timestamp="1517893200">0</item>
    <item timestamp="1517979600">1</item>
    <item timestamp="1518066000">0</item>
  </calls>
  <log_events>
    <item timestamp="1517461200">0</item>
    <item timestamp="1517547600">0</item>
    <item timestamp="1517634000">0</item>
    <item timestamp="1517720400">0</item>
    <item timestamp="1517806800">0</item>
    <item timestamp="1517893200">0</item>
    <item timestamp="1517979600">0</item>
    <item timestamp="1518066000">0</item>
  </log_events>
  <loops_per_call>
    <item timestamp="1517461200">0</item>
    <item timestamp="1517547600">0</item>
    <item timestamp="1517634000">0</item>
    <item timestamp="1517720400">0</item>
    <item timestamp="1517806800">0</item>
    <item timestamp="1517893200">0</item>
    <item timestamp="1517979600">0</item>
    <item timestamp="1518066000">0</item>
  </loops_per_call>
  <form_items>
    <item timestamp="1517461200">0</item>
    <item timestamp="1517547600">0</item>
    <item timestamp="1517634000">0</item>
    <item timestamp="1517720400">0</item>
    <item timestamp="1517806800">0</item>
    <item timestamp="1517893200">0</item>
    <item timestamp="1517979600">0</item>
    <item timestamp="1518066000">0</item>
  </form_items>
  <loops>
    <item timestamp="1517461200">0</item>
    <item timestamp="1517547600">0</item>
    <item timestamp="1517634000">0</item>
    <item timestamp="1517720400">0</item>
    <item timestamp="1517806800">0</item>
    <item timestamp="1517893200">0</item>
    <item timestamp="1517979600">0</item>
    <item timestamp="1518066000">0</item>
  </loops>
  <average_form_items>
    <item timestamp="1517461200">0</item>
    <item timestamp="1517547600">0</item>
    <item timestamp="1517634000">0</item>
    <item timestamp="1517720400">0</item>
    <item timestamp="1517806800">0</item>
    <item timestamp="1517893200">0</item>
    <item timestamp="1517979600">0</item>
    <item timestamp="1518066000">0</item>
  </average_form_items>
</result>
```

{% endtab %}
{% endtabs %}
{% endtab %}

{% tab title="400 " %}
{% tabs %}
{% tab title="JSON" %}

```javascript
HTTP/1.1 400 Bad Request
X-RateLimit-Limit: 150
X-RateLimit-Remaining: 149
X-RateLimit-Reset: 1519659000
Content-Length: 90
Content-Type: application/json

{"error":"Invalid start parameter."}
```

{% endtab %}

{% tab title="XML" %}

```markup
HTTP/1.1 400 Bad Request
X-RateLimit-Limit: 150
X-RateLimit-Remaining: 149
X-RateLimit-Reset: 1519659000
Content-Length: 120
Content-Type: application/json

<?xml version="1.0"?>
<result>
  <error>Invalid start parameter.</error>
</result>
```

{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

### **Possible Response Codes**

* **200**: success, data successfully returned.
* **400**: supplied data improperly formatted or invalid
* **401**: authentication parameters invalid or the account is inactive
* **405**: invalid HTTP method supplied (only POST allowed)
* **429**: rate limit exceeded
* **500**: unknown error

The return structure will contain the following item(s):

| Name                 | Data Type | Always Present | Description                                                                                                        |
| -------------------- | --------- | -------------- | ------------------------------------------------------------------------------------------------------------------ |
| error                | string    | no             | Indicates what went wrong when an HTTP code other than 200 is returned.                                            |
| calls                | array     | no             | A 200 HTTP code returns this value, the list of call counts grouped by period timestamp.                           |
| log\_events          | array     | no             | A 200 HTTP code returns this value, the list of log event counts grouped by period timestamp.                      |
| loops\_per\_call     | array     | no             | A 200 HTTP code returns this value, the list of average loops per call grouped by period timestamp.                |
| form\_items          | array     | no             | A 200 HTTP code returns this value, the list of count of form items grouped by period timestamp.                   |
| loops                | array     | no             | A 200 HTTP code returns this value, the list of count of loops grouped by period timestamp.                        |
| average\_form\_items | array     | no             | A 200 HTTP code returns this value, the list of average number of form items per call grouped by period timestamp. |

### **Sample Code**

This sample code makes a request to fetch events data using PHP but any language capable of integrating with a REST API can be used:

```php
<?php
// authentication and filter settings
$login = '<your_temporary_login>';
$password = '<your_temporary_password>';
$start = '<start_date>';
$end = '<end_date>';
$period = '<selected_period>';
$phone = '<selected_phone_number>';

// build the URL
$url = 'https://voicetrends.plumvoice.com/api/events/'.$start.'/'.$end.'/'.$period.'/'.$phone;

$ch = curl_init();
curl_setopt($ch, CURLOPT_USERPWD, $login.':'.$password);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json"));
$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($result);
var_dump($http_code);
```


---

# Agent Instructions: 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:

```
GET https://docs.plumvoice.com/voicetrends/voicetrends-api/event-tracker.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.