Track_details API

When the recipient opens or clicks your email, his address will be added to the list of opens and clicks, in which you can search the address you want.

Query

URL

https://email.api.engagelab.cc/v1/track_details

          https://email.api.engagelab.cc/v1/track_details

This code block in the floating window

HTTP Request Method

GET

GET

This code block in the floating window

Header

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Query Parameter Description

parameter	type	required or not	description
time_zone	string	*	time zone, example：+8, defaults +8
start_date	string	*	format of start date is `yyyy-MM-dd`
end_date	string	*	format of end date is `yyyy-MM-dd`
email	string	*	learn more about the address in the list
track_type	string	no	`1` means opens，`2` means clicks，no parameter included means to search both
api_users	string	no	obtain stats of specified API_USER; multiple API_USERs are separated by semicolons, e.g. api_users=a;b;c
label_ids	string	no	obtain stats of specified label; multiple labels are separated by semicolons, for example,label_ids=a;b;c
offset	int	no	start position, [0-], defaults to 0
limit	int	no	amount, [0-100],defaults to 100

Request Example:

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/track-details?offset=0&limit=3'

          curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/track-details?offset=0&limit=3'

This code block in the floating window

Returned Value Description

parameter	description
email	email address
label_id	email label_id
track_type	opens or clicks
url	clicked url
api_user	apiUser name
curr_time	time of opens or clicks
ip	ip of opens or clicks
country	ip of country
province	ip of province
city	ip of city
browser	browser of open or click
device	device of open or click

Returned Value Example:

{ "result": [ { "email": "opfwefs@gmail.com", "track_type": 1, "api_user": "sendcloud_op**s", "url": "", "curr_time": "2021-06-09 09:49:30", "email_id": "162320******_143833_116562_2325.sc-10_9_13_213-inbound0$ops@send.im", "ip": "47.190.78.5", "country": "United States", "province": "Texas", "city": "Southlake", "browser": "google", "device": "" } ], "count": 1 "total":2 }

             { 
   "result": [
        {
            "email": "opfwefs@gmail.com",
            "track_type": 1,
            "api_user": "sendcloud_op**s",
            "url": "",
            "curr_time": "2021-06-09 09:49:30",
            "email_id": "162320******_143833_116562_2325.sc-10_9_13_213-inbound0$ops@send.im",
            "ip": "47.190.78.5",
            "country": "United States",
            "province": "Texas",
            "city": "Southlake",
            "browser": "google",
            "device": ""
        }
    ],
    "count": 1
    "total":2
  }

This code block in the floating window