Description

This is a Service to create an analytics event linked with a pre registration user or User. One of either advertisingId or userId should be present.

Request Endpoint

POST https://<Example api server address>/api/event

Parameters

None.

cURL syntax

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"advertisingId\": \"fbee8eb3-9cb8-4a55-b30c-296b44111089\",
    \"userId\": \"fbee8eb3-9cb8-4a55-b30c-296b44111089\",
    \"deviceId\":\"fbee8eb3-9cb8-4a55-b30c-296b44111089\",
    \"events\": [
        {
            \"event\": \"App deposit\",
            \"timestamp\": 178900812,
            \"data\": {
                \"x-event\": \"Something\"
            }
        }
    ]
}" \
'https://core.dev.Example.net/api/event'

POST body attributes (JSON)

Attribute	Type	Use	Description
advertisingId	String	Optional	Id of the user who was pre-registered from the Web.
userId	String	Optional	Id of the user who is registered with Example.
deviceId	String	Required	Id of the device where the event was created.
events	Array	Required	An array of events to be posted.
event	String	Required	Name of the event.
timestamp	Number	Required	Timestamp at which the event occurred. This should be a UNIX timestamp value.
data	String	Required	A set of key value pairs to represent dynamic data.

POST body

Headers: Content-Type: application/json

{
  "advertisingId": "fbee8eb3-9cb8-4a55-b30c-296b44111089",
  "userId": "fbee8eb3-9cb8-4a55-b30c-296b44111089",
  "deviceId": "fbee8eb3-9cb8-4a55-b30c-296b44111089",
  "events": [
    {
      "event": "App deposit",
      "timestamp": 178900812,
      "data": {
        "x-event": "Something"
      }
    }
  ]
}

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": [
    {
      "id": "0031c7cf-38a8-4e1a-9eba-ffc5fe26b078",
      "updatedBy": "",
      "event": "App deposit",
      "advertisingId": "fbee8eb3-9cb8-4a55-b30c-296b44111089",
      "userId": "fbee8eb3-9cb8-4a55-b30c-296b44111089",
      "deviceId": "fbee8eb3-9cb8-4a55-b30c-296b44111089",
      "timestamp": 178900812,
      "data": {
        "x-event": "Something"
      }
    }
  ],
  "detail": null,
  "error": false,
  "message": "Analytics event added successfully"
}

Return to top

Description

This service will fetch all the device application history based on following 4 scenarios:

1. only userId
2. userId and device Udid passed
3. userId and applicationId passed
4. userId, deviceUdids and applicationId

offset and limit parameters can be passed in the url query to control the results returned.

Example URI

POST https://<Example api server address>/user/device/application/history

Parameters

None.

cURL syntax

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"userId\": \"605d92e8-800c-46a7-81cc-a07340a69774\",
    \"deviceUdid\": [
        \"1\"
    ],
    \"applicationId\" : \"cbab1a87-243a-4319-8ae4-e93ca5cc3f6f\"
}" \
'https://core.dev.Example.net/api/user/device/application/history'

POST body attributes (JSON)

Attribute	Type	Use	Description
userId	String	Required	UUID of a user.
deviceUdid	String	Optional	UDID of the device.
applicationId	String	Optional	UUID of an application.

POST body

Headers: Content-Type: application/json

{
  "userId": "605d92e8-800c-46a7-81cc-a07340a69774",
  "deviceUdid": [
    "1"
  ],
  "applicationId": "cbab1a87-243a-4319-8ae4-e93ca5cc3f6f"
}

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": [
    {
      "id": "8de9be82-9031-412c-a7d7-72ead56bbad5",
      "updatedBy": "",
      "actionDetails": [
        {
          "actionDate": 1455625763174,
          "actionType": "INSTALL",
          "build": null,
          "remarks": null,
          "version": null,
          "bundlePackageId": "bundle123"
        },
        {
          "actionDate": 1455625772776,
          "actionType": "UPDATED",
          "build": null,
          "remarks": null,
          "version": null,
          "bundlePackageId": null
        },
        {
          "actionDate": 1455625775118,
          "actionType": "UPDATED",
          "build": null,
          "remarks": null,
          "version": null,
          "bundlePackageId": null
        },
        {
          "actionDate": 1455625775800,
          "actionType": "UPDATED",
          "build": null,
          "remarks": null,
          "version": null,
          "bundlePackageId": null
        },
        {
          "actionDate": 1455625776466,
          "actionType": "UPDATED",
          "build": null,
          "remarks": null,
          "version": null,
          "bundlePackageId": null
        }
      ],
      "application": {
        "id": "cbab1a87-243a-4319-8ae4-e93ca5cc3f6f",
        "updatedBy": "",
        "appPackage": null,
        "banner": null,
        "bundleIdentifier": "bundle123",
        "casino": {
          "id": "38d09d6e-12e1-44cb-ba2f-c69afc2806f3",
          "updatedBy": "",
          "imageUrl": "UserAppCas",
          "name": "UserAppCas",
          "videoUrl": "UserAppCas"
        },
        "casinoId": null,
        "category": {
          "id": "5a1e1b8b-db12-4f64-a6ae-85cf1c6dbc90",
          "updatedBy": "",
          "imageUrl": "UserAppCat",
          "name": "UserAppCat",
          "videoUrl": "UserAppCat"
        },
        "categoryId": null,
        "description": null,
        "downloads": null,
        "featured": null,
        "gameAppVersions": null,
        "image": null,
        "keywords": null,
        "latestBuild": null,
        "latestVersion": null,
        "name": "Useful",
        "order": null,
        "paragraph1": null,
        "paragraph2": null,
        "paragraph3": null,
        "paragraph4": null,
        "presetPriceList": null,
        "price": null,
        "publisher": null,
        "ranking": null,
        "rating": null,
        "sliderImages": null,
        "subtitle": null,
        "updated": null,
        "video": null
      },
      "device": {
        "id": "3cb2003f-8fdd-4daa-8731-9e50309b8b5b",
        "updatedBy": "",
        "description": "Old Device",
        "deviceStatus": "NORMAL",
        "manufacturer": "Apple",
        "model": "iPhone 5",
        "os": "iOS 9",
        "udid": "1"
      },
      "lastActionDate": 1455625776466,
      "lastActionType": "UPDATED",
      "lastBuild": null,
      "lastVersion": null,
      "user": {
        "id": "605d92e8-800c-46a7-81cc-a07340a69774",
        "updatedBy": "",
        "addresses": null,
        "birthDateDay": 12,
        "birthDateMonth": 1,
        "birthDateYear": 1945,
        "devices": [
          {
            "id": "3cb2003f-8fdd-4daa-8731-9e50309b8b5b",
            "updatedBy": "",
            "description": "Old Device",
            "deviceStatus": "NORMAL",
            "manufacturer": "Apple",
            "model": "iPhone 5",
            "os": "iOS 9",
            "udid": "1"
          }
        ],
        "emailAuthenticationChannels": [],
        "firstName": "Shruti ",
        "fullName": "Shruti  Nagarkar",
        "lastName": "Nagarkar",
        "locationCountry": "United Kingdom",
        "locationZipCode": "1234234",
        "mobileAuthenticationChannels": [],
        "pinCreated": false,
        "profileImagePath": null,
        "profileName": "SRN",
        "registrationDate": 1455625364451,
        "socialAuthenticationChannels": [
          {
            "addedOn": 1455625364451,
            "blockStatus": "NORMAL",
            "deletedOn": null,
            "lastUsedOn": 1455625432248,
            "loginType": "FACEBOOK",
            "socialId": "social123"
          }
        ],
        "status": "EXISTING",
        "timezone": null,
        "userSetting": null,
        "verified": true
      }
    }
  ],
  "detail": null,
  "error": false,
  "message": "Fetched all user device application history successfully"
}

Return to top