Skip to main content
POST
/
page
cURL
curl --request POST \
  --url https://api.unifyintent.com/analytics/v1/page \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "page",
  "visitorId": "<string>",
  "sessionId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z",
  "context": {
    "library": {
      "name": "<string>",
      "version": "<string>"
    },
    "ip": "127.0.0.1",
    "locale": "<string>",
    "userAgent": "<string>",
    "userAgentData": {
      "brands": [
        {
          "brand": "<string>",
          "version": "<string>"
        }
      ],
      "mobile": true,
      "platform": "<string>"
    },
    "utm": {
      "source": "<string>",
      "medium": "<string>",
      "campaign": "<string>",
      "term": "<string>",
      "content": "<string>"
    }
  },
  "name": "<string>",
  "properties": {
    "path": "<string>",
    "query": {},
    "referrer": "<string>",
    "title": "<string>",
    "url": "<string>"
  }
}'

Body

application/json

A page view event represents a client visiting a page on a website.

​
type
enum<string>
required

The type of analytics event being sent.

Available options:
page
​
visitorId
string
required

Unique identifier for the visitor that triggered this event.

​
sessionId
string
required

Unique identifier for the session in which this event occurred.

​
timestamp
string<date-time>
required

Timestamp of the event (in UTC).

​
context
object
required

Contextual information about the client behind the event. Contextual client information attached to an analytics event.

​
sentAt
string<date-time>

Timestamp at which the request is sent (in UTC).

Typically, this value is nearly identical to timestamp. However in some situations there is latency between when the event occurs and when it is sent to Unify.

​
name
string

Name of the page that was viewed.

​
properties
object

Details about the page that was viewed. Details about a page included in a page request.

Response

The request has succeeded.

⌘I