chatkitty/docs/AnalyticsApi.md

OpenAPI client for chatkitty

# AnalyticsApi

All URIs are relative to *https://api.chatkitty.com*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**exportMessageAnalytics**](#exportmessageanalytics) | **POST** /analytics/messages | Export message analytics|
|[**exportUserAnalytics**](#exportuseranalytics) | **POST** /analytics/users | Export user analytics|

# **exportMessageAnalytics**
> ApplicationJobResource exportMessageAnalytics()

Batch export message analytics data

### Example

```typescript
import {
    AnalyticsApi,
    Configuration
} from 'chatkitty';

const configuration = new Configuration();
const apiInstance = new AnalyticsApi(configuration);

const { status, data } = await apiInstance.exportMessageAnalytics();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ApplicationJobResource**

### Authorization

[application_authorization](../README.md#application_authorization)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**404** | Resource not found |  -  |
|**403** | Access is denied |  -  |
|**400** | Client error |  -  |
|**401** | Unauthorized: Full authentication is required to access this resource |  -  |
|**202** | Export job accepted |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **exportUserAnalytics**
> ApplicationJobResource exportUserAnalytics()

Batch export user analytics data

### Example

```typescript
import {
    AnalyticsApi,
    Configuration
} from 'chatkitty';

const configuration = new Configuration();
const apiInstance = new AnalyticsApi(configuration);

const { status, data } = await apiInstance.exportUserAnalytics();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ApplicationJobResource**

### Authorization

[application_authorization](../README.md#application_authorization)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**404** | Resource not found |  -  |
|**403** | Access is denied |  -  |
|**400** | Client error |  -  |
|**401** | Unauthorized: Full authentication is required to access this resource |  -  |
|**202** | Export job accepted |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)