🚀Analytics API Endpoint

This endpoint will send analytics data to NTH using ABO Manager and generate unique authentication code, short code, and keyword for a service hosted by Comparo Media.

If you have been provided with a staging key, you must use the staging Base URL for API Endpoints: https://staging.comparocms.com/api

Base URL for API Endpoints: https://comparocms.com/api

It's your responsibility to secure the token shared by the API team, using it publically allows anyone to access and make requests on behalf of you for the service.

For token related queries, contact your Comparo Media partner or send an email to [email protected].

Flow: MSIDN INSERT / PIN SUBMIT

POST /analytics

MSIDN Insert flow for NTH / PIN Submit flow for NTH

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Required	Type	Example	Description
mobile_number		string		Mobile number / MSIDN of the user, required for MSIDN INSERT flow / Pin submit flow. Prefix mobile number with: 00{country_code_without_+_symbol}
aff_parameters		object		Object with clickid and trackid details, passed as-is to ABO Manager, optional
aff_parameters.clickid		string	123456	Click ID, passed to ABO Manager as-is
aff_parameters.trid		string	123456	Track ID, passed to ABO Manager as-is

Response

200

Successful request

{
    "responseStatus": "200",
    "message": "6HT",
    "opportunityEndUserId": "144370666",
    "page_next": "INFO"
}

400

Missing Mobile Number

{
    "status": false,
    "message": "Please add Mobile Number"
}

401

Missing Auth Token

{
    "status": false,
    "message": "HTTP/1.0 401 Unauthorized. Token not found in request."
}

Flow: Click 2 SMS

POST /analytics

Click 2 SMS flow for NTH

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Required	Type	Example	Description
aff_parameters		object		Object with clickid and trackid details, passed as-is to ABO Manager, optional
aff_parameters.clickid		string	123456	Click ID, passed to ABO Manager as-is
aff_parameters.trid		string	123456	Track ID, passed to ABO Manager as-is

Response

200

Successful request

{
    "responseStatus": "200",
    "sms_code": "6HT",
    "opportunityEndUserId": "144370666",
    "page_next": "INFO",
    "KW": "FRT",
    "SHID": "860860"
}

401

Missing Auth Token

{
    "status": false,
    "message": "HTTP/1.0 401 Unauthorized. Token not found in request."
}

Flow: Verify Pin

POST /pin_verify

Verify the pin with MSISDN

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Required	Type	Example	Description
mobile_number		string		Mobile number / MSIDN of the user, required for MSIDN INSERT flow / Pin submit flow. Prefix mobile number with: 00{country_code_without_+_symbol}
pin		string		Pin to verify the MSISDN.
opportunityEndUserId		number		The number that you get in the first API response.
aff_parameters		object		Object with clickid and trackid details, passed as-is to ABO Manager, optional
aff_parameters.clickid		string	123456	Click ID, passed to ABO Manager as-is
aff_parameters.trid		string	123456	Track ID, passed to ABO Manager as-is

Response

200

{
    "responseStatus": "200",
    "message": "6HT",
    "opportunityEndUserId": "144370666",
    "page_next": "INFO"
}

401

{
    "status": false,
    "message": "HTTP/1.0 401 Unauthorized. Token not found in request."
}