User Activity Executive Summary API

Overview

This API will give the executive summary of identified user for the given date range when the Data Subject has exercised Right of access by the data subject under Art. 15 GDPR.

Base URL

US IDC:
https://api.netcoresmartech.com/apiv2?type=export_data&activity=get_user_summary_data&apikey=

Indian IDC:
https://apiin.netcoresmartech.com/apiv2?type=export_data&activity=get_user_summary_data&apikey=

Europe IDC:
https://euceeapi.netcorecloud.net/apiv2?type=export_data&activity=get_user_summary_data&apikey=

HTTP Method

POST

Body Parameters

ParameterDetailTypeIs MandatoryExample Value
typePass the type of data which you want to exportStringYesexport_data
activityPass the activity name for export dataStringYesget_user_summary_data
apikeyCEE API KeyStringYesAPI key string
dataPass the input data as JSONJSON StringYesdata will be JSON string. The below key : value param will be acceptable

primary_key (PK of user)
from_data (ddmmyyyy)
* to_date (ddmmyyyy)

API Sample

https://<API_END_POINT>?type=export_data&activity=get_user_summary_data&apikey=<API_KEY>&data={"primary_key":"End User Primary Key","from_date":"<FROM_DATE>","to_date":"<TO_DATE>"}

API Response

Response Example - In the Success case

{
    "status": "success",
    "primary_key": "<PK>",
    "result": {
        "user_data": {
            "attribute_data": {
              	"Attribute_KEY":"Attribute_VALUE"
            },
            "activity_data": [
              	// Array of activity data
            ],
            "channel_activity_data": {
                "email": {
                    "sent": [
                      // campaign id of email sent activity
                    ],
                    "open": [
                      // campaign id of email open activity
                    ],
                    "clicked": [
                      // campaign id of email click activity
                    ]
                },
                "sms": {
                    "delivered": [],
                    "sent": [
                      // campaign ids of sms sent activity
                    ],
                    "clicked": [
                      // campaign ids of sms link click activity
                    ]
                },
                "apn": {
                    "published": [
                      // campaign ids of apn published
                    ],
                    "clicked": [
                      // campaign ids of apn clicked
                    ]
                },
                "bpn": {
                    "published": [
                      // campaign ids of bpn published
                    ],
                    "clicked": [
                      // campaign ids of bpn clicked
                    ]
                },
                "webmsg": {
                    "view": [
                      // campaign ids of webmessage view
                    ],
                    "clicked": [
                      // campaign ids of webmessage click
                    ]
                },
                "inapp": {
                    "view": [
                      // campaign ids of inapp view
                    ],
                    "clicked": [
                      // campaign ids of inapp click
                    ]
                }
            }
        },
        "from_date": "from_date",
        "to_date": "to_date"
    },
    "details": "Data fetched successfully"
}

Response Sample

{
    "status": "success",
    "primary_key": "[email protected]",
    "result": {
        "user_data": {
            "attribute_data": {
                "FIRSTNAME": "fname",
                "LASTNAME": "lname",
                "GENDER": null,
                "BIK_INT": null,
                "AGE": "27",
                "SALARY": null,
            },
            "activity_data": [
                {
                    "activity_id": 1,
                    "activity": "Page Browse",
                    "count": 18
                },
                {
                    "activity_id": 28,
                    "activity": "Product View",
                    "count": 2
                },
            ],
            "channel_activity_data": {
                "email": {
                    "sent": [
                        458,
                        459
                    ],
                    "open": [
                        459
                    ],
                    "clicked": [
                        459
                    ]
                },
                "sms": {
                    "delivered": [],
                    "sent": [
                        140,
                        142
                    ],
                    "clicked": [
                        142
                    ]
                },
                "apn": {
                    "published": [
                        46
                    ],
                    "clicked": [
                        46
                    ]
                },
                "bpn": {
                    "published": [
                        276,
                        283
                    ],
                    "clicked": [
                        276,
                        283
                    ]
                },
                "webmsg": {
                    "view": [
                        55,
                        56
                    ],
                    "clicked": [
                        55
                    ]
                },
                "inapp": {
                    "view": [
                        1
                    ],
                    "clicked": [
                        1
                    ]
                }
            }
        },
        "from_date": "15072018",
        "to_date": "19072018"
    },
    "details": "Data fetched successfully"
}