Retrieve Email Statistics

Retrieve Email Statistics (Deprecated)

GET/apps/{app_key}/email_stats/{since_date}/{to_date}

Use it in a workflow

Add a step and choose the Yotpo connector.
Pick the Retrieve Email Statistics action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{retrieveEmailStatistics.response.data}}.

Request

Path parameters

app_keystringrequired

Your Yotpo account API key

since_datestringrequired

Retrieve email statistics from this date

to_datestringrequired

Retrieve email statistics until this date

Query parameters

aggregatestringrequired

Aggregate result dates. valid values are one of the following: ["day", "week", "month", "quarter", "year"]

categoriesstringrequired

Each mail is defined by a single category. Should be comma separated.

utokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](doc:yotpo-authentication) to learn how to generate your utoken.

Response

Returns 200 with an object. Read it in later steps with {{retrieveEmailStatistics.response.data.<field>}}.

statusobject

codeinteger

Default 0

messagestring

responseobject

mail_after_serviceobject5 fields

mapobject5 fields

json

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "response": {
    "mail_after_service": {
      "2015-06-01,2015-06-07": {
        "delivered": 12,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 0,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 1,
        "repeat_spamreports": 0,
        "requests": 13,
        "spamreports": 0
      },
      "2015-06-08,2015-06-14": {
        "delivered": 5,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 1,
        "repeat_unsubscribes": 0,
        "unique_clicks": 0,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 6,
        "spamreports": 0
      },
      "2015-06-15,2015-06-21": {
        "delivered": 18,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 1,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 18,
        "spamreports": 0
      },
      "2015-06-22,2015-06-28": {
        "delivered": 6,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 0,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 6,
        "spamreports": 0
      },
      "2015-06-29,2015-06-29": {
        "delivered": 0,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 0,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 0,
        "spamreports": 0
      }
    },
    "map": {
      "2015-06-01,2015-06-07": {
        "delivered": 19,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 3,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 19,
        "spamreports": 0
      },
      "2015-06-08,2015-06-14": {
        "delivered": 15,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 2,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 15,
        "spamreports": 0
      },
      "2015-06-15,2015-06-21": {
        "delivered": 21,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 0,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 21,
        "spamreports": 0
      },
      "2015-06-22,2015-06-28": {
        "delivered": 20,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 3,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 20,
        "spamreports": 0
      },
      "2015-06-29,2015-06-29": {
        "delivered": 4,
        "unsubscribes": 0,
        "invalid_email": 0,
        "bounces": 0,
        "repeat_unsubscribes": 0,
        "unique_clicks": 0,
        "blocked": 0,
        "spam_drop": 0,
        "repeat_bounces": 0,
        "repeat_spamreports": 0,
        "requests": 4,
        "spamreports": 0
      }
    }
  }
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.

Was this page helpful?