Example Client APIs - User Acquisition APIs

User Acquisition APIs

Click an API to expand/collapse it.

POSTUser Acquisition Landing Page

Description

Sets acquisition records on the landing page. Note:

Before calling user acquisition, the Create Store App (/store) API should perform which will contain the Example apk name as a downloadLink.

From the response: Use id as GUID.

Request Endpoint

POST https://<Example api server address>/acquisition/landing

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"uaLandingDeviceType\": \"device type1\",
    \"uaDownloadUserAgent\": \"landing\",
    \"uaLandingPageVersion\": \"v1.0\",
    \"uaLinkType\": \"EMAIL\",
    \"uaApp\": \"lOXgmJLQRA\",
    \"uaLandingUserAgent\": \"agnt1\",
    \"uaBreferrer\": \"uaBreferrer 1\",
    \"uaSource\": \"SINGULAR\",
    \"uaReferrer\": \"referrer1\",
    \"uaReferrerUrl\": \"url1\"
}" \
'https://core.dev.Example.net/api/acquisition/landing'
POST body attributes (JSON)

Attribute Type Use Description

uaApp String Required An app bundle identifier.

uaSource String Required SINGULAR.

uaLinkType String Optional SMS or EMAIL.

uaReferrer String Optional The referrer.

uaLandingUserAgent String Optional The landing user agent.

uaLandingDeviceType String Optional The device type.

uaDownloadUserAgent String Optional The download agent.

uaLandingPageVersion String Optional The landing page version.

uaBreferrer String Optional The Breferrer.

uaReferrerUrl String Optional The Referrer Url.

POST body
Headers: Content-Type: application/json
{
  "uaLandingDeviceType": "device type1",
  "uaDownloadUserAgent": "landing",
  "uaLandingPageVersion": "v1.0",
  "uaLinkType": "EMAIL",
  "uaApp": "lOXgmJLQRA",
  "uaLandingUserAgent": "agnt1",
  "uaBreferrer": "uaBreferrer 1",
  "uaSource": "SINGULAR",
  "uaReferrer": "referrer1",
  "uaReferrerUrl": "url1"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
    "data": {
        "id": "369f00a0-06a7-413e-a8fa-70ae65f92573",
        "deleted": false,
        "uaSource": "SINGULAR",
        "uaApp": "lOXgmJLQRA",
        "uaReferrer": "referrer1",
        "uaReferrerUrl": "www.url1"
        "uaLandingUserAgent": "agnt1",
        "uaLandingDeviceType": "device type1",
        "uaLinkType": "EMAIL",
        "linkTypeValue": null,
        "uaDownloadUserAgent": "landing",
        "uaLandingPageVersion": "v1.0",
        "acquisitionStates": [{
            "uaUserStatus": "LandingPage",
            "timeStamp": 1478501648580
        }],
        "uaAppUrl": null,
        "uaReferrerUrl": null,
        "uaAdPartner": null,
        "uaBreferrer": "uaBreferrer 1",
        "uaNALandingUserAgent": null
    },
    "detail": null,
    "error": false,
    "message": "Acquisition LandingPage success."
}
Return to top

Attribute	Type	Use	Description
`uaApp`	String	Required	An app bundle identifier.
`uaSource`	String	Required	SINGULAR.
`uaLinkType`	String	Optional	SMS or EMAIL.
`uaReferrer`	String	Optional	The referrer.
`uaLandingUserAgent`	String	Optional	The landing user agent.
`uaLandingDeviceType`	String	Optional	The device type.
`uaDownloadUserAgent`	String	Optional	The download agent.
`uaLandingPageVersion`	String	Optional	The landing page version.
`uaBreferrer`	String	Optional	The Breferrer.
`uaReferrerUrl`	String	Optional	The Referrer Url.

PUTUser Acquisition Link Sent

Description

Sets the GUID and provides the latest apk link.

Request Endpoint

PUT https://<Example api server address>/acquisition/link/sent

Parameters

None.

cURL syntax

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"id\": \"369f00a0-06a7-413e-a8fa-70ae65f92573\",
    \"uaLinkType\" : \"EMAIL\",
    \"linkTypeValue\" : \"sudipta.bhaumik@innoflexion.com\"
}" \
'https://core.dev.Example.net/api/acquisition/link/sent'

PUT body attributes (JSON)

Attribute	Type	Use	Description
`id`	String	Required	The acquisition id.
`uaLinkType`	String	Required	EMAIL / SMS.
`linkTypeValue`	String	Required	Email or phone number.

PUT body

Headers: Content-Type: application/json

{
  "id": "369f00a0-06a7-413e-a8fa-70ae65f92573",
  "uaLinkType": "EMAIL",
  "linkTypeValue": "sudipta.bhaumik@innoflexion.com"
}

Response body

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

{
  "data": {
    "id": "369f00a0-06a7-413e-a8fa-70ae65f92573",
    "deleted": false,
    "uaSource": "SINGULAR",
    "uaApp": "lOXgmJLQRA",
    "uaReferrer": "referrer1",
    "uaLandingUserAgent": "agnt1",
    "uaLandingDeviceType": "device type1",
    "uaLinkType": "EMAIL",
    "linkTypeValue": "sudipta.bhaumik@innoflexion.com",
    "uaDownloadUserAgent": "landing",
    "uaLandingPageVersion": "v1.0",
    "acquisitionStates": [
      {
        "uaUserStatus": "LandingPage",
        "timeStamp": 1478501648580
      },
      {
        "uaUserStatus": "LinkSent",
        "timeStamp": 1478501649256
      }
    ],
    "uaAppUrl": null,
    "uaReferrerUrl": null,
    "uaAdPartner": null,
    "uaBreferrer": "uaBreferrer 1",
    "uaNALandingUserAgent": null
  },
  "detail": null,
  "error": false,
  "message": "Acquisition LinkSent success."
}

Return to top

PUTUser Acquisition DownloadPage

Description

Updates the DownloadPage status.

If GUID (id) is passed, it will modify the status with the following response type, otherwise, it will create a new record.

This service will return the Example apk download magic url as well.

Request Endpoint

PUT https://<Example api server address>/acquisition/download/page

Parameters

None.

cURL syntax
curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"id\": \"369f00a0-06a7-413e-a8fa-70ae65f92573\"
}" \
'https://core.dev.Example.net/api/acquisition/download/page'
PUT body attributes (JSON)

Attribute Type Use Description

id String Optional The acquisition id.

uaApp String Optional The app bundle identifier.

uaSource String Optional SINGULAR.

uaReferrer String Optional The referrer.

uaLandingUserAgent String Optional The landing user agent.

uaLandingDeviceType String Optional The device type.

uaDownloadUserAgent String Optional The download agent.

uaLandingPageVersion String Optional The landing page version.

uaBreferrer String Optional The Breferrer.

uaReferrerUrl String Optional The referrer url.

PUT body
Headers: Content-Type: application/json
{
  "id": "369f00a0-06a7-413e-a8fa-70ae65f92573"
}
Response body
Headers: Content-Type: application/json | HTTPS Status Code: 200
{
  "data": {
    "id": "369f00a0-06a7-413e-a8fa-70ae65f92573",
    "deleted": false,
    "uaSource": "SINGULAR",
    "uaApp": "lOXgmJLQRA",
    "uaReferrer": "referrer1",
    "uaLandingUserAgent": "agnt1",
    "uaLandingDeviceType": "device type1",
    "uaLinkType": "EMAIL",
    "linkTypeValue": null,
    "uaDownloadUserAgent": "landing",
    "uaLandingPageVersion": "v1.0",
    "acquisitionStates": [
      {
        "uaUserStatus": "LandingPage",
        "timeStamp": 1478501648580
      },
      {
        "uaUserStatus": "LinkSent",
        "timeStamp": 1478501649256
      },
      {
        "uaUserStatus": "DownloadPage",
        "timeStamp": 1478501649374
      }
    ],
    "uaAppUrl": "https://btc.inf.apdx.mkt.s3-us-west-2.amazonaws.com/?response-content-disposition=attachment%3Bfilename%3DBetcadeStore_369f00a0-06a7-413e-a8fa-70ae65f92573.apk&AWSAccessKeyId=AKIAIDQFME7VFTZRPEKQ&Expires=1478505249&Signature=dxJ8GcfO3IZyzRpDjzg1BGA8ILY%3D",
    "uaReferrerUrl": null,
    "uaAdPartner": null,
    "uaBreferrer": "uaBreferrer 1",
    "uaNALandingUserAgent": null
  },
  "detail": null,
  "error": false,
  "message": "Acquisition DownloadPage success."
}
Return to top

Attribute	Type	Use	Description
`id`	String	Optional	The acquisition id.
`uaApp`	String	Optional	The app bundle identifier.
`uaSource`	String	Optional	SINGULAR.
`uaReferrer`	String	Optional	The referrer.
`uaLandingUserAgent`	String	Optional	The landing user agent.
`uaLandingDeviceType`	String	Optional	The device type.
`uaDownloadUserAgent`	String	Optional	The download agent.
`uaLandingPageVersion`	String	Optional	The landing page version.
`uaBreferrer`	String	Optional	The Breferrer.
`uaReferrerUrl`	String	Optional	The referrer url.

PUTUser Acquisition Download Started

Description

Updates the Download started status.

Request Endpoint

PUT https://<Example api server address>/acquisition/download/started

Parameters

None.

cURL syntax

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"id\": \"369f00a0-06a7-413e-a8fa-70ae65f92573\"
}" \
'https://core.dev.Example.net/api/acquisition/download/started'

PUT body attributes (JSON)

Attribute	Type	Use	Description
`id`	String	Required	The acquisition id.

PUT body

Headers: Content-Type: application/json

{
  "id": "369f00a0-06a7-413e-a8fa-70ae65f92573"
}

Response body

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

{
  "data": {
    "id": "369f00a0-06a7-413e-a8fa-70ae65f92573",
    "deleted": false,
    "uaSource": "SINGULAR",
    "uaApp": "lOXgmJLQRA",
    "uaReferrer": "referrer1",
    "uaLandingUserAgent": "agnt1",
    "uaLandingDeviceType": "device type1",
    "uaLinkType": "EMAIL",
    "linkTypeValue": null,
    "uaDownloadUserAgent": "landing",
    "uaLandingPageVersion": "v1.0",
    "acquisitionStates": [
      {
        "uaUserStatus": "LandingPage",
        "timeStamp": 1468399251320
      },
      {
        "uaUserStatus": "LinkSent",
        "timeStamp": 1468399263582
      },
      {
        "uaUserStatus": "DownloadPage",
        "timeStamp": 1468399268589
      },
      {
        "uaUserStatus": "DownloadStarted",
        "timeStamp": 1468399598585
      }
    ],
    "uaReferrerUrl": null,
    "uaAdPartner": null,
    "uaBreferrer": "uaBreferrer 1",
    "uaNALandingUserAgent": null
  },
  "detail": null,
  "error": false,
  "message": "Acquisition DownloadStarted success."
}

Return to top

PUTUser Acquisition AppLaunched

Description

Updates the AppLaunched status.

Request Endpoint

PUT https://<Example api server address>/acquisition/app/launched

Parameters

None.

cURL syntax

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"id\": \"93ab983d-f81c-469a-8dc2-b23f50691312\"
}" \
'https://core.dev.Example.net/api/acquisition/app/launched'

PUT body attributes (JSON)

Attribute	Type	Use	Description
`id`	String	Required	The acquisition id.

PUT body

Headers: Content-Type: application/json

{
  "id": "93ab983d-f81c-469a-8dc2-b23f50691312"
}

Response body

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

{
  "data": {
    "id": "93ab983d-f81c-469a-8dc2-b23f50691312",
    "uaSource": "SINGULAR",
    "uaApp": null,
    "uaLandingUserAgent": "agnt1",
    "uaLandingDeviceType": "device type1",
    "uaLinkType": "EMAIL",
    "uaDownloadUserAgent": "landing",
    "uaLandingPageVersion": "v1.0",
    "acquisitionStates": [
      {
        "uaUserStatus": "LandingPage",
        "timeStamp": 1468399251320
      },
      {
        "uaUserStatus": "LinkSent",
        "timeStamp": 1468399263582
      },
      {
        "uaUserStatus": "DownloadPage",
        "timeStamp": 1468399268589
      },
      {
        "uaUserStatus": "DownloadStarted",
        "timeStamp": 1468399598585
      },
      {
        "uaUserStatus": "AppLaunched",
        "timeStamp": 1468399598585
      }
    ]
  },
  "detail": null,
  "error": false,
  "message": "Acquisition AppLaunched success."
}

Return to top

GETUser Acquisition Fetch

Description

Gets a user acquisition.

Request Endpoint

GET https://<Example api server address>/acquisition/{id}

Parameters

Parameter	Type	Use	Description
id	String	Required	The acquisition id.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/acquisition/id'

Response body

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

{
  "data": {
    "id": "93ab983d-f81c-469a-8dc2-b23f50691312",
    "uaSource": "SINGULAR",
    "uaApp": "b45899a3-f71d-4d4d-9359-bc885d529fa2",
    "uaLandingUserAgent": "agnt1",
    "uaLandingDeviceType": "device type1",
    "uaLinkType": "EMAIL",
    "uaDownloadUserAgent": "landing",
    "uaLandingPageVersion": "v1.0",
    "acquisitionStates": [
      {
        "uaUserStatus": "LandingPage",
        "timeStamp": 1468399251320
      },
      {
        "uaUserStatus": "LinkSent",
        "timeStamp": 1468399263582
      },
      {
        "uaUserStatus": "DownloadPage",
        "timeStamp": 1468399268589
      },
      {
        "uaUserStatus": "DownloadStarted",
        "timeStamp": 1468399598585
      },
      {
        "uaUserStatus": "AppLaunched",
        "timeStamp": 1468399598585
      }
    ]
  },
  "detail": null,
  "error": false,
  "message": "Acquisition fetch success."
}

Return to top