Smartech

User Activity Channel API

  1. apiv2 is missing in GDPR api endpoints
  2. Also Request Sample json parameters are not correct

Overview

Smartech 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

HTTP Method

POST

Body Parameters

Parameter
Detail
Type
Is Mandatory
Example Value

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 (channel identifier)
  • from_date (ddmmyyyy)
  • to_date (ddmmyyyy)

Request Sample

data={
	"primary_key":"someemail@gmai.com",
  "channel":"email",
	"from_date":"15072018",
	"to_date":"19072018"
}

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."
}

User Activity Channel API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.