データ統計
呼び出しアドレス
| データセンター | URL |
|---|---|
| シンガポール | https://email.api.engagelab.cc |
| トルコ | https://emailapi-tr.engagelab.com |
REST APIを使用する際は、選択したデータセンターが適切なベースURLに対応していることを確認してください。
POST/v1/stats_day
送信データ統計（日次）
日次のメールデータ統計
URL
https://email.api.engagelab.cc/v1/stats_day
https://email.api.engagelab.cc/v1/stats_day
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | 型 | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
クエリパラメータの説明
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| time_zone | string | No | タイムゾーン。デフォルトタイムゾーン: +8 |
| start_date | string | Yes | 開始日、フォーマット: yyyy-MM-dd |
| end_date | string | Yes | 終了日、フォーマット: yyyy-MM-dd |
| api_users | string | No | 特定のAPI_USERの統計を取得、複数のAPI_USERは;で区切る。例: api_users=a;b;c |
| label_ids | string | No | 特定のラベルの統計を取得、複数のラベルは;で区切る。例: label_ids=a;b;c |
| domain_names | string | No | 特定の受信ドメインの統計を取得、複数のドメインは;で区切る。例: domain_names=a;b;c |
| aggregate_by | int | No | デフォルトは0（集計なし）。1に設定すると、すべての次元の集計データを返します。 |
注意:
クエリ間隔は3か月を超えてはなりません。
リクエスト例
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/day_stats?start_date=2015-02-01&end_date=2015-02-28&api_user_list=***;***&aggregate_by=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| send_date | 送信日 |
| api_user | API_USER |
| domain | 受信ドメイン |
| label_id | ラベルID |
| label_name | ラベル名 |
| targets | 合計ターゲット数、リクエスト数 |
| sent | 送信されたメール数 |
| delivered | 配信されたメール数 |
| invalid_email | 無効なメール数 |
| soft_bounce | ソフトバウンス数 |
| report_spam | スパム報告数 |
| total_clicks | 合計クリック数 |
| total_opens | 合計開封数 |
| opens | 開封数 |
| clicks | クリック数 |
| unsubscribe | 解除数 |
| delivered_percent | 配信率 |
| invalid_email_percent | 無効なメール率 |
| soft_bounce_percent | ソフトバウンス率 |
| report_spam_percent | スパム報告率 |
| total_click_percent | 合計クリック率 |
| total_open_percent | 合計開封率 |
| open_percent | 開封率 |
| click_percent | クリック率 |
| unsubscribe_percent | 解除率 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
}
# 集計データ, aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
{
"result": [
{
"send_date": "2022-10-25",
"api_user": "test1212",
"domain": "qq.com",
"label_id": 0,
"label_name": "",
"targets": 1,
"delivered": 0,
"sent":1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"opens_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
]
}
# 集計データ, aggregate_by = 1
{
"result": {
"targets": 146013,
"sent":13322,
"delivered": 2,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 146011,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 100.0
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます
送信データ統計（時間別）
時間別のメールデータ統計
URL
https://email.api.engagelab.cc/v1/stats_hour
https://email.api.engagelab.cc/v1/stats_hour
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | 型 | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
クエリパラメータの説明
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| time_zone | string | No | タイムゾーン。デフォルトタイムゾーン: +8 |
| send_date | string | Yes | リクエスト送信日、フォーマット: yyyy-MM-dd |
| api_users | string | No | 特定のAPI_USERの統計を取得、複数のAPI_USERは;で区切る。例: api_users=a;b;c |
| label_ids | string | No | 特定のラベルの統計を取得、複数のラベルは;で区切る。例: label_ids=a;b;c |
リクエスト例
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
curl "https://email.api.engagelab.cc/v1/stats_hour?send_date=2022-11-21" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>""
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| send_date | 送信日 |
| send_hour | 特定の時間、範囲 [0-23] |
| api_user | API_USER |
| label_id | ラベルID |
| targets | 合計ターゲット数、リクエスト数 |
| sent | 送信されたメール数 |
| delivered | 配信されたメール数 |
| invalid_email | 無効なメール数 |
| soft_bounce | ソフトバウンス数 |
| report_spam | スパム報告数 |
| total_clicks | 合計クリック数 |
| total_opens | 合計開封数 |
| opens | 開封数 |
| clicks | クリック数 |
| unsubscribe | 解除数 |
| delivered_percent | 配信率 |
| invalid_email_percent | 無効なメール率 |
| soft_bounce_percent | ソフトバウンス率 |
| report_spam_percent | スパム報告率 |
| total_click_percent | 合計クリック率 |
| total_open_percent | 合計開封率 |
| open_percent | 開封率 |
| click_percent | クリック率 |
| unsubscribe_percent | 解除率 |
レスポンス例
Response-success
HTTP Status: 200
# 特定の時間にsendHourが返されない場合、その時間にデータがないことを意味します
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_emails": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
# 特定の時間にsendHourが返されない場合、その時間にデータがないことを意味します
{
"result": [
{
"send_date": "2022-08-25",
"api_user": "zymtest4",
"label_id": 598121,
"send_hour": 11,
"targets": 1,
"sent":1,
"delivered": 1,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_emails": 0,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
},
{
"send_date": "2022-08-25",
"api_user": "gaolei",
"label_id": 598125,
"send_hour": 15,
"targets": 1,
"sent":1,
"delivered": 0,
"total_clicks": 0,
"total_opens": 0,
"soft_bounce": 0,
"report_spam": 0,
"unsubscribe": 0,
"opens": 0,
"clicks": 0,
"invalid_email": 1,
"delivered_percent": 0.0,
"total_click_percent": 0.0,
"total_open_percent": 0.0,
"soft_bounce_percent": 0.0,
"report_spam_percent": 0.0,
"unsubscribe_percent": 0.0,
"open_percent": 0.0,
"click_percent": 0.0,
"invalid_email_percent": 0.0
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます
無効なメール統計（日次）
無効なメールの分類統計をクエリ
URL
https://email.api.engagelab.cc/v1/stat_invalids
https://email.api.engagelab.cc/v1/stat_invalids
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | 型 | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
クエリパラメータの説明
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| time_zone | string | No | タイムゾーン。デフォルトタイムゾーン: +8 |
| start_date | string | Yes | 開始日、フォーマット: yyyy-MM-dd |
| end_date | string | Yes | 終了日、フォーマット: yyyy-MM-dd |
| api_users | string | No | 特定のAPI_USERの統計を取得、複数のAPI_USERは;で区切る。例: api_users=a;b;c |
| label_ids | string | No | 特定のラベルの統計を取得、複数のラベルは;で区切る。例: label_ids=a;b;c |
| domain_names | string | No | 特定の受信ドメインの統計を取得、複数のドメインは;で区切る。例: domain_names=a;b;c |
| aggregate_by | int | No | デフォルトは0（集計なし）。1に設定すると、すべての次元の集計データを返します。 |
注意:
- クエリ期間は3か月を超えてはなりません。
aggregate_byが1に設定されている場合、すべての次元のデータが集計され累積されます。
リクエスト例
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/stats_invalid" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| フィールド | 説明 |
|---|---|
| send_date | 送信日、フォーマット: yyyy-MM-dd |
| api_user | API_USER |
| domain | 受信ドメイン |
| label_id | ラベルID |
| label_name | ラベル名 |
| blacklists | ブラックリスト数 |
| unsubscribes | 解除リスト数 |
| server_errors | 到達不能サーバー数 |
| format_errors | 受信者フォーマットエラー数 |
| ip_domain_rejecteds | IPまたはドメイン拒否数 |
| not_exists | 存在しない受信者数 |
| spams | スパムメール数 |
| sender_recipient_rejecteds | 送信者または受信者拒否数 |
| others | その他 |
レスポンス例
Response-success
HTTP Status: 200
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# 集計データ, aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
{
"result": [
{
"send_date": "2022-12-01",
"api_user": "1224_xjm",
"label_id": 0,
"label_name": null,
"domain": "qq.com",
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 0,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 1
}
]
}
# 集計データ, aggregate_by = 1
{
"result": {
"blacklists": 0,
"unsubscribes": 0,
"server_errors": 88387,
"format_errors": 0,
"not_exists": 0,
"spams": 0,
"sender_recipient_rejecteds": 0,
"others": 57624
}
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
このコードブロックはフローティングウィンドウ内に表示されます
