Webhooks

Webhooks allow you to receive programmatic calls when our data is updated. Webhooks are only configurable for Premium members. You can add your webhook endpoint in the API Keys console.

In case the Webhook request failed, we may try calling it again several times. Please ensure that your webhook endpoint returns a success HTTP status code of 200 to avoid unnecessary retries.

Currently, we support the following webhook events:

raw-data-updated

This event is called at least once a day when all the raw data CSVs are updated, typically around UTC 13:00-15:00, but could be later. The webhook event will be a POST request to the specified webhook URL, where the POST body would look like this:

{
  "event": "raw-data-files",
  "date": "2025-01-27",
  "files": [
    {
      "type": "full",
      "name": "ranking-stats-20250127.csv",
      "key": "ranking-stats/2025/ranking-stats-20250127.csv"
    },
    {
      "type": "mini",
      "name": "mini-ranking-stats-20250127.csv",
      "key": "mini-ranking-stats/2025/mini-ranking-stats-20250127.csv"
    },
    {
      "type": "author",
      "name": "author-ranking-stats-20250127.csv",
      "key": "author-ranking-stats/2025/author-ranking-stats-20250127.csv"
    },
    {
      "type": "obsolete",
      "name": "obsolete-extensions-20250127.csv",
      "key": "obsolete-extensions/2025/obsolete-extensions-20250127.csv"
    },
    {
      "type": "recently-updated",
      "name": "recently-updated-extensions-20250127.csv",
      "key": "recently-updated-extensions/2025/recently-updated-extensions-20250127.csv"
    },
    {
      "type": "reviews-stats",
      "name": "reviews-ranking-stats-20250127.csv",
      "key": "reviews-ranking-stats/2025/reviews-ranking-stats-20250127.csv"
    },
    {
      "type": "cat-stats",
      "name": "cat-ranking-stats-20250127.csv",
      "key": "cat-ranking-stats/2025/cat-ranking-stats-20250127.csv"
    },
    {
      "type": "col-stats",
      "name": "col-ranking-stats-20250127.csv",
      "key": "col-ranking-stats/2025/col-ranking-stats-20250127.csv"
    },
    {
      "type": "keyword-stats",
      "name": "keyword-ranking-stats-20250127.csv",
      "key": "keyword-ranking-stats/2025/keyword-ranking-stats-20250127.csv"
    },
    {
      "type": "store-summary",
      "name": "store-summary-stats-20250127.csv",
      "key": "store-summary-stats/2025/store-summary-stats-20250127.csv"
    },
    ...
  ]
}

You may use the /api/raw-data API with the provided key to download the contents of the raw data CSV.