Ctrlk
SupportDashboardGuides
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Events

The Events endpoint allows you to retrieve all the Contact's location events and application events from your Cloud4Wi account.

List of Events:

  • "signup": a Contact is created in your Cloud4Wi account, either when a person signs up from the guest WiFi, a Kiosk or via APIs

  • "visit": a Contact leaves a location after a visit. The event includes the visit metadata such as location and durations

  • "login": a Contact authenticates to a WiFi network, either on the guest WiFi, WPA2-Enterprise or Passpoint

  • "promo": a Contact clicks on a call to action in the Promo Page interstitial content. See Promo Page documentation.

  • "survey": a Contact responds to a survey. See Survey documentation

  • "send_email": an email has been sent via Campaign

  • "open_email": an email sent via Campaign has been opened

  • "click_email": a trackable link of an email sent via Campaign has been clicked

  • "send_sms": an SMS has been sent via Campaign

  • "click_sms": a trackable link of an SMS sent via Campaign has been clicked

Endpoints

List all events for an organziation id

get

List all Events, including Visits, WiFi connections and application events, of an Organization Retrieve all events og of the given organization .
Role: Organization Manager
Scope: organization_read, events_read

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
cidstringRequired

id of the organization (aka tenant)

Query parameters
dateStartstringOptional

Return events with date >= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

dateEndstringOptional

Return events with date <= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

eventsstringOptional

List of events (comma separated). Possible values: visit,signup, login, send_email,open_email,click_email,send_sms,click_sms,survey, promo

sizestringOptional

Number of events returned by the request. Allowed values between 1 and 10000. It is not possible to change this values during a scrolling.

sortBystringOptional

Sort list by: businessTime, utcTime (default is businessTime)

sortReversebooleanOptional

Reverse sort order

enableScrollbooleanOptional

Enable scroll. If true, the response will contain a scrollId. Use it to get the next page of results.

scrollIdbooleanOptional

Scroll id. Use it to get the next page of results.

Responses
200

Response

application/json
statusstringOptional

OK

generatedstringOptional

date time of response

countnumberOptional
get/v1/organizations/{cid}/events
GET /v1/organizations/{cid}/events HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "text",
  "generated": "text",
  "count": 1,
  "events": [
    {
      "type": "text",
      "id": "text",
      "visit": {
        "startAt": "text",
        "startAtLocal": "text",
        "timezone": "text",
        "duration": 1
      },
      "signup": {
        "source": "text"
      },
      "email": {
        "campaignId": "text",
        "communicationId": "text",
        "channel": "text",
        "campaignName": "text",
        "email": "text"
      },
      "sms": {
        "campaignId": "text",
        "communicationId": "text",
        "channel": "text",
        "campaignName": "text",
        "phone": "text",
        "prefix": "text"
      },
      "survey": {
        "campaignId": "text",
        "campaignName": "text",
        "answerId": "text",
        "questions": {
          "question_1": "text"
        },
        "answers": {
          "answer_1": "text"
        }
      },
      "promo": {
        "type": "text"
      }
    }
  ]
}

List all events of a specific Contact

get

List all events, including WiFi Connections, Visits and applicaiton events of a given Contact Id
Role: Organization Manager
Scope: organization_read, events_read

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
cidstringRequired

id of the organization (aka tenant)

idstringRequired

id of the user (ID of the table w.USERS) passed inside the JWT received at login

Query parameters
dateStartstringOptional

Return events with date >= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

dateEndstringOptional

Return events with date <= of request. Format is date iso8601. Eg: 2019-07-31T22:23:24Z

eventsstringOptional

List of events (comma separated). Possible values: visit,signup, login, send_email,open_email,click_email,send_sms,click_sms,survey, promo

sizestringOptional

Number of events returned by the request. Allowed values between 1 and 10000. It is not possible to change this values during a scrolling.

sortBystringOptional

Sort list by: businessTime, utcTime (default is businessTime)

sortReversebooleanOptional

Reverse sort order

Responses
200

Response

application/json
statusstringOptional

OK

generatedstringOptional

date time of response

countnumberOptional
get/v1/organizations/{cid}/customers/{id}/events
GET /v1/organizations/{cid}/customers/{id}/events HTTP/1.1
Host: explore.cloud4wi.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "text",
  "generated": "text",
  "count": 1,
  "events": [
    {
      "type": "text",
      "id": "text",
      "visit": {
        "startAt": "text",
        "startAtLocal": "text",
        "timezone": "text",
        "duration": 1
      },
      "signup": {
        "source": "text"
      },
      "email": {
        "campaignId": "text",
        "communicationId": "text",
        "channel": "text",
        "campaignName": "text",
        "email": "text"
      },
      "sms": {
        "campaignId": "text",
        "communicationId": "text",
        "channel": "text",
        "campaignName": "text",
        "phone": "text",
        "prefix": "text"
      },
      "survey": {
        "campaignId": "text",
        "campaignName": "text",
        "answerId": "text",
        "questions": {
          "question_1": "text"
        },
        "answers": {
          "answer_1": "text"
        }
      },
      "promo": {
        "type": "text"
      }
    }
  ]
}

Data example

Example of the response of the endpoint https://explore.cloud4wi.com//v1/organizations/{cid}/events

PreviousWiFi logs
NextWebhooks

Last updated

Was this helpful?