Retrieve an event

GET/cdp/{connection_id}/event/{id}

Parameters

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this event object
`created_at`	string (date-time)	No	The date that this event object was ingested (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`name`	string	No	The specific event name (eg. "Product Purchased")
`type`	enum	No	The unified structural category of the event Values: `TRACK`, `PAGE`, `SCREEN`, `IDENTIFY`, `GROUP`, `ALIAS`
`occurred_at`	string (date-time)	No	When the event actually happened (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`profile_id`	string	No	The profile this event is associated with; points to CdpProfile
`identifiers`	CdpIdentifier[]	No	The identifiers that link this event to a profile
`identifiers[].type`	enum	No	The type of the identifier (eg. EMAIL, USER_ID, ANONYMOUS_ID) Values: `EMAIL`, `USER_ID`, `ANONYMOUS_ID`, `DEVICE_ID`, `PHONE`, `CRM_ID`, `LOYALTY_ID`, `OTHER`
`identifiers[].value`	string	Yes	The identifier value that resolves to the profile
`identifiers[].is_primary`	boolean	No	Whether this is the primary identifier for the profile
`identifiers[].encoding`	string	No	The encoding of the identifier value (eg. raw, sha256)
`identifiers[].source`	string	No	The source that provided this identifier
`metadata`	CdpMetadata[]	No	The event payload/properties
`metadata[].id`	string	No
`metadata[].slug`	string	No	The attribute/trait key (eg. lifetime_value)
`metadata[].value`	object	No	The attribute/trait value
`metadata[].namespace`	string	No	The scope or origin of the attribute (eg. computed, event, visitor)
`metadata[].format`	enum	No	The data type of the attribute value Values: `TEXT`, `NUMBER`, `DATE`, `BOOLEAN`, `ARRAY`, `OBJECT`
`metadata[].extra_data`	object	No
`source`	string	No	The source that produced this event
`source_id`	string	No	The cdp_source this event originated from; points to CdpSource

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.cdp.getCdpEvent({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

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

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

cURL

curl --request GET \
  --url 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/event/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?