User Channel Activity API

Overview

CEE provides the API to enable the client to support GDPR requests when the Data Subject has exercised Right of access by the data subject under Art. 15 GDPR

By this API client can get user's channel wise activity.

Base URL

US IDC:
https://api.netcoresmartech.com/apiv2?type=export_data&activity=get_user_channel_activity_data&apikey=<API_KEY>

Indian IDC:
https://apiin.netcoresmartech.com/apiv2?type=export_data&activity=get_user_channel_activity_data&apikey=<API_KEY>

Europe IDC:
https://euceeapi.netcorecloud.net/apiv2?type=export_data&activity=get_user_channel_activity_data&apikey=<API_KEY>

HTTP Method

POST

Body Parameters

Parameter	Detail	Type	Is Mandatory	Example Value
type	Pass the type of data that you want to export	String	Yes	export_data
activity		String	Yes	get_user_summary_data
apikey	CEE API Key	String	Yes	901d733fcaf5fcfa4209e3b07540ae90
data	Pass the as JSON	JSON String	Yes	data will be JSON string. The below key : value param will be acceptable primary_key (PK of user) channel (sms or email ) fromdate (DDMMYYY) to_date (DDMMYYYY)

Request Sample

data={
	"primary_key":"[email protected]",
  "channel":"email",
	"from_date":"15072018",
	"to_date":"19072018"
}

API Curl call request

curl --location 'https://api.netcoresmartech.com/apiv2?type=export_data&activity=get_user_channel_activity_data&apikey=%3CAPI%20KEY%3E'
--header 'Content-Type: application/json'
--data 'data={"primary_key": "","channel": "sms","from_date": "DDMMYYYY","to_date": "DDMMYYYY"}'

API Response

Response Example - In the Success case

{
    "status": "success",
    "result": {
        "channel_activity": [
          // array of channel activity
        ],
        "from_date": "<from_date>",
        "to_date": "<to_date>",
        "channel": "<channel>"
    },
    "details": "Data fetched successfully."
}

Response Sample

{
    "status": "success",
    "result": {
        "channel_activity": [
            {
                "activity": "sent",
                "message_id": 462,
                "msg_name": "Sample EMAil broadcast to check all activities",
                "activity_date": "23 Jul 2018 @11:02am"
            },
            {
                "activity": "open",
                "ip": "192.168.41.50",
                "message_id": 462,
                "msg_name": "Sample EMAil broadcast to check all activities",
                "activity_date": "23 Jul 2018 @3:33pm",
                "device": "DESKTOP",
                "os": "UNIX",
                "browser": "Google Chrome"
            },
            {
                "activity": "click",
                "ip": "192.168.41.50",
                "link": "http://www.cricbuzz.com/[EMAIL]",
                "message_id": 462,
                "msg_name": "Sample EMAil broadcast to check all activities",
                "activity_date": "23 Jul 2018 @3:33pm",
                "device": "DESKTOP",
                "os": "UNIX",
                "browser": "Google Chrome"
            }
        ],
        "from_date": "19072018",
        "to_date": "23072018",
        "channel": "email"
    },
    "details": "Data fetched successfully."
}

Updated 3 months ago