開封クリックリスト

ユーザーが開封またはクリックしたメールは、そのアドレスが開封クリックリストに追加されます。

このリストに対してクエリ操作を実行できます。

呼び出しアドレス

データセンター	URL
シンガポール	https://email.api.engagelab.cc
トルコ	https://emailapi-tr.engagelab.com

REST APIを使用する際は、選択したデータセンターが適切なベースURLに対応していることを確認してください。

POST/v1/track_details

クエリ

URL

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

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

このコードブロックはフローティングウィンドウ内に表示されます

HTTPリクエストメソッド

GET

GET

このコードブロックはフローティングウィンドウ内に表示されます

ヘッダー

ヘッダー	タイプ	必須	説明
Authorization	string	true	Basic base64(api_user:api_key)

クエリパラメータの説明

パラメータ	タイプ	必須	説明
time_zone	string	*	タイムゾーン、例: +8、デフォルトは+8
start_date	string	*	開始日、形式は`yyyy-MM-dd`
end_date	string	*	終了日、形式は`yyyy-MM-dd`
email	string	*	開封クリックリスト内のこのアドレスの詳細をクエリ
track_type	string	No	`1`は開封、`2`はクリック；指定しない場合、すべての開封とクリックをクエリ
api_users	string	No	指定されたAPI_USERの統計を取得、複数のAPI_USERは`;`で区切る、例: apiUserList=a;b;c
label_ids	string	No	指定されたラベルの統計を取得、複数のラベルはセミコロンで区切る、例: label_ids=a;b;c
offset	int	No	クエリ位置、範囲[0-]、デフォルトは0
limit	int	No	クエリ数、範囲[0-100]、デフォルトは100

リクエスト例:

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'

このコードブロックはフローティングウィンドウ内に表示されます

レスポンスの説明

パラメータ	説明
email	メールアドレス
label_id	メールラベルID
track_type	開封またはクリックのタイプ
url	クリックされたURL
api_user	API_USER名
curr_time	開封またはクリックの時間
ip	開封またはクリックのIP
country	IPの国
province	IPの州
city	IPの都市
browser	使用されたブラウザ名
device	使用されたデバイス名

レスポンス例:

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

このコードブロックはフローティングウィンドウ内に表示されます