Payload Object

This page includes some sample payloads for Alerts from different datasets.

Alert payload is a loosely structured metadata associated with a particular Alert. You will find that information presented in this field significantly varies depending on the Alert's dataset, class.code and resource.type. It means that when working with payload object, you must implement conditional handling of fields, as they might be missing or have an unexpected value type.

News Alerts

{
  "data": {
    "news_source": "bombardier.com"
  }
}

Commodity Alerts

{
  "data": {
    "snippet": "OTHER METALS: LME aluminium gained 1% to $2,582.50 a tonne, zinc added 0.2% to $3,289.50, nickel advanced 1.8% to $19,745, lead rose 0.2% to $2,345, but tin shed 0.7% to $37,150.",
    "news_url": "https://www.reuters.com/article/global-metals-idUSL1N2S1114",
    "news_source": "Reuters",
    "event_attributes": {
      "commodity_id": "Tin",
      "sourcecountry": null,
      "commodity_name": "Tin",
      "business_signal": "Decrease in Commodity Price"
    }
  },
  "type": "news_commodities"
}

Jobs Alerts

{
  "data": {
    "timeseries": [
      {
        "date": "2020-05-25",
        "value": 36,
        "period_type": "default"
      },
      {
        "date": "2020-05-26",
        "value": 34,
        "period_type": "default"
      }
    ],
    "period_info": {
      "pct_change": -0.25161290322580643,
      "time_window": "month",
      "period_value": 155,
      "period_actual_date": "2021-04-01 00:00:00"
    }
  },
  "meta": {},
  "type": "change_over_period"
}