Engagement Quality Scores
親アカウントのSendGrid Engagement Quality (SEQ)を取得するAPI、サブユーザのSEQを取得するAPIの2種類があります。
SEQを取得するには、以下の2つの条件を満たす必要があります。
- Open Trackingを有効にしている
- 過去30日間に1,000通以上送信している
SEQは最長90日間保存されます。
Get Engagement Quality Scores
指定した期間のアカウントのSEQを取得します。
Request
1
| |
| URI引数 | 必須 | 条件 | 説明 |
|---|---|---|---|
| from | Yes | YYYY-mm-dd形式 | SEQを取得する開始日（UTC） |
| to | Yes | YYYY-mm-dd形式 | SEQを取得する終了日（UTC） |
Response
正常応答として200と202のいずれかが返却されます。
200
fromとtoパラメータで指定された期間に算出されているスコアがあった場合、レスポンスコード200が返却されます。指定期間のうちスコアが取得できない日にちについてはscoreとmetricsは省略されます。
レスポンスのscoreパラメータはSEQの全体スコア、 metricsパラメータは全体スコア算出の基となる各カテゴリのスコアです。スコアは1から5の値を取り、大きいほど良好であることを意味します。
各カテゴリの詳細は概要を参照してください。
| JSONパラメータ | 型 | 必須 | 制限 | 詳細 | |
|---|---|---|---|---|---|
| result | オブジェクト配列 |  |
|||
| SEQスコア及びそのメタデータからなるオブジェクトの配列 | |||||
| user_id | string | Yes | |
||
| スコア算出元アカウントのUser ID | |||||
| username | string | |
|||
| スコア算出元アカウントのUsername | |||||
| date | string | |
|||
| スコア算出元の日付（UTC） | |||||
| score | number | 1〜5の間 |
|
||
| SEQの全体スコア。Open Trackingが無効、または過去30日間の送信が1,000通に満たない場合は算出できないため省略される。 | |||||
| metrics | オブジェクト | |
|||
| 5つのカテゴリのスコアから構成されるオブジェクト。スコアが算出できない場合は省略される。スコアは値が大きいほど良好であることを表す。 | |||||
| engagement_recency | number | Yes | 1〜5の間 |
|
|
| エンゲージのある宛先に送信しているかを表す指標。どれくらい頻繁に開封やクリックされているか等により決まる。 | |||||
| open_rate | number | Yes | 1〜5の間 |
|
|
| 受信者がメールを開封しているかを表す指標 | |||||
| bounce_rate | number | Yes | 1〜5の間 |
|
|
| 存在しない宛先に送信していないかを表す指標。恒久的なバウンスの数により決まる。 | |||||
| bounce_classification | number | Yes | 1〜5の間 |
|
|
| レピュテーションやコンテンツが原因でバウンスしていないかを表す指標。送信処理されたメールに対する特定のタイプのバウンスの数により決まる。 | |||||
| spam_rate | number | Yes | 1〜5の間 |
|
|
| 迷惑メール報告されていないかを表す指標。メールを開封して迷惑メール報告した宛先の数により決まる。 | |||||
202
指定された期間のスコアがまだ算出されていない場合、レスポンスコード202が返却されます。スコアはAPIリクエストとは独立に非同期で算出されるため、APIリクエスト時にはまだスコアが取得できない場合があります。
Get Subusers’ Engagement Quality Scores
指定した日付のサブユーザのSEQを取得します。
Request
1
| |
| URI引数 | 必須 | 条件 | 説明 |
|---|---|---|---|
| date | Yes | YYYY-mm-dd形式 | SEQを取得する日付（UTC） |
| limit | integer | SEQを取得するサブユーザ数を制限します。デフォルト値は1000です。 | |
| after_key | integer | 結果を分割取得する際に利用します。limitの制限を超えるサブユーザがある場合、レスポンスにafter_keyの値が含まれます。そのafter_keyをリクエストで指定すると、残りのサブユーザのSEQを取得します。 |
Response
正常応答として200と202のいずれかが返却されます。
200
指定された日付のデータがあった場合レスポンスコードは200となり、アカウントに属するサブユーザの結果が返却されます。データが取得できないサブユーザについてはscoreとmetricsは省略されます。
レスポンスのscoreパラメータはSEQの全体スコア、 metricsパラメータは全体スコア算出の基となる各カテゴリのスコアです。スコアは1から5の値を取り、大きいほど良好であることを意味します。
各カテゴリの詳細は概要を参照してください。
| JSONパラメータ | 型 | 必須 | 制限 | 詳細 | |
|---|---|---|---|---|---|
| result | オブジェクト配列 | Yes | |
||
| SEQスコア及びそのメタデータからなるオブジェクトの配列 | |||||
| user_id | string | Yes | |
||
| スコア算出元のサブユーザのUser ID | |||||
| username | string | |
|||
| スコア算出元のサブユーザのUsername | |||||
| date | string | |
|||
| スコア算出元の日付（UTC） | |||||
| score | number | 1〜5の間 |
|
||
| SEQの全体スコア。Open Trackingが無効、または過去30日間の送信が1,000通に満たない場合は算出できないため省略される。 | |||||
| metrics | オブジェクト | |
|||
| 5つのカテゴリのスコアから構成されるオブジェクト。スコアが算出できない場合は省略される。スコアは値が大きいほど良好であることを表す。 | |||||
| engagement_recency | number | Yes | 1〜5の間 |
|
|
| エンゲージのある宛先に送信しているかを表す指標。どれくらい頻繁に開封やクリックされているか等により決まる。 | |||||
| open_rate | number | Yes | 1〜5の間 |
|
|
| 受信者がメールを開封しているかを表す指標 | |||||
| bounce_rate | number | Yes | 1〜5の間 |
|
|
| 存在しない宛先に送信していないかを表す指標。恒久的なバウンスの数により決まる。 | |||||
| bounce_classification | number | Yes | 1〜5の間 |
|
|
| レピュテーションやコンテンツが原因でバウンスしていないかを表す指標。送信処理されたメールに対する特定のタイプのバウンスの数により決まる。 | |||||
| spam_rate | number | Yes | 1〜5の間 |
|
|
| 迷惑メール報告されていないかを表す指標。メールを開封して迷惑メール報告した宛先の数により決まる。 | |||||
| _metadata | オブジェクト | |
|||
APIレスポンスのメタデータからなるオブジェクト。after_keyが含まれる場合、limitを超えて取得されていないサブユーザがあることを意味する。次のリクエストパラメータにafter_keyを指定することで続きを取得可能。 |
|||||
| next_params | オブジェクト | |
|||
| after_key | string | |
|||
結果に含まれる最後のアカウントのキー。nullの場合はこれ以上データがないことを表す。 |
|||||
202
指定された日付のスコアがまだ算出されていない場合、レスポンスコード202が返却されます。スコアはAPIリクエストとは独立に非同期で算出されるため、APIリクエスト時にはまだスコアが取得できない場合があります。