Get Events

1 min

GET

https://api.upstartcommerce.com/v1/siteactivity/events

This endpoint returns information about the consumer's activity to be distributed inside the system.

Authorized permissions:

siteactivity.event.read

Authorized roles:

customer.default
customer.anonymous

Query Parameters

sessionIdstring
Description
When included, this causes the response to return data based on the provided session id. When it is not included, the request will generate a new session id.

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.

Responses

200

Success–events array returned with a session identifier for future calls.

OutClientEvents
Description
List of events for a given session id.
- eventsOutClientEvent[]required
  Description
  An event returned by the service, with its payload, originating service and the sites it applies to.
  - createdstring<date-time>required
    Example
    2017-07-21T17:32:28Z
    Description
    The date/time on which the event was generated.
    Format
    date-time
  - idstring<uuid>required
    Description
    Unique identifier for an event.
    Format
    uuid
  - namestringrequired
    Description
    This identifies the type of event that was triggered.
  - payloadobjectrequired
    Description
    Depending on the type of event that was triggered, this will contain relevant information and data.
  - siteIdsstring[]required
  - servicestringrequired
    Description
    This identifies the service that generated the event.
  - traceIdstringrequired
    Description
    For internal consumption by UpStart Commerce; to allow tracking of this event through various systems.
- sessionIdstringrequired

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Description
Error payload returned when a request fails validation, identifying the offending input by name, code and detail.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request GET \
     --url https://api.upstartcommerce.com/v1/siteactivity/events \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/siteactivity/events", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/siteactivity/events")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"

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

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/siteactivity/events"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Success–events array returned with a session identifier for future calls.
{
  "events": [
    {
      "created": "2017-07-21T17:32:28Z",
      "id": "",
      "name": "",
      "payload": {},
      "siteIds": [
        ""
      ],
      "service": "",
      "traceId": ""
    }
  ],
  "sessionId": ""
}

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}