...
| Contents on this page | |
|---|---|
|
GET /realtime-data-export
Provides a list of all realtime data exports associated with the authenticated user's account.
GET /realtime-data-export?id=[id]
Provides information about a specific realtime data export.
DELETE /realtime-data-export?id=[id]
Deletes a specific realtime data export.
POST /realtime-data-export
Description
Create a Realtime Data Export stream
Endpoint
/realtime-data-export
Method
POST
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| title | string | Y | |
| settings | string | Y | JSON string. Possible options for this are explained below. This must be url encoded. |
...
| Name | Type | Required | Description |
|---|---|---|---|
| outputs | array | Y | See details below |
| rules | array | Y | See details below |
| fields | array | Y | For a possible option, check the Column Names in this link: Log Format |
Outputs
The output is where the data will be exported to. The possible options per output can be found below.
...
| Name | Type | Required | Description |
|---|---|---|---|
| accessKey | string | Y | The AWS Access Key |
| accessSecret | string | Y | The AWS Secret |
| region | string | Y | The AWS region |
| streamName | string | Y | To which Kinesis stream the data should be sent. |
PubSub
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | Y | |
| topicId | string | Y | The PubSub topic |
| jsonKey | string | Y | Google JSON key (string) that has permissions to produce to PubSub |
HTTPS
| Name | Type | Required | Description |
|---|---|---|---|
| endpoint | string | Y | To which endpoint the data should be outputted. |
| secret | string | Y | The secret of this endpoint. |
BigQuery
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | Y | |
| datasetName | string | Y | |
| tablePrefix | string | Y | |
| jsonKey | string | Y | Google JSON key (string) that has permissions to produce to BigQuery, create datasets, etc. |
Please refer to the section authentication for the auth and csrf tokens.
Rules
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Can be either:
| |
| comparator | string | Can be either:
| |
| value | string | Comma separated list of acceptable values | |
| type | string | Can be either:
|
PubSub
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | Y | |
| topicId | string | Y | The PubSub topic |
| jsonKey | string | Y |
HTTPS
| Name | Type | Required | Description |
|---|---|---|---|
| endpoint | string | Y | To which endpoint the data should be outputted. |
| secret | string | Y | The secret of this endpoint. |
...
BigQuery
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | Y | |
| datasetName | string | Y | |
| tablePrefix | string | Y | |
| jsonKey | string | Y |
Example JSON
| Code Block | ||
|---|---|---|
| ||
{
"outputs": {
"type": "bigquery",
"settings": {
"projectid": "test-1234",
"datasetName": "test",
"tablePrefix": "test",
"jsonKey": "{\"a\":\"b\"}"
}
},
"rules": [{
"id": "pixel_id",
"type": "dimension",
"comparator": "=",
"value": "12345"
}],
"fields": ["pixel_id", "uuid"]
} |
Please refer to the section authentication for the auth and csrf tokens.