LogoLogo
Request an API keyBack to Craft.co
  • Introduction
  • About GraphQL
  • Authentication
  • Troubleshooting
  • Company Data API
    • Company Data API Introduction
    • Getting started
      • Getting started with JavaScript
      • Getting started with Python
      • Getting started with Ruby
      • Getting started with cURL
    • Query Parameters
    • Data Categories
      • Basic Company Information
        • USG Prohibited List
        • Security Rating
        • Gov Spending
        • Unspsc Code
        • Patent
        • Stock Market
        • Tag
      • Financials
        • Private Valuation
        • Funding Rounds
        • Income Statement
        • Cash Flow Statement
        • Balance Sheet
        • Revenue Breakdown
        • Acquisitions
        • Analyst Ratings
        • Filing
        • Stock Summary
        • Latest Z Score
        • Ratios
      • Human capital
        • Company Ratings
        • Employee Numbers
        • Human Capital Metrics
        • Job Categories
        • Jobs
        • Key Executives
        • Salaries
      • Operating data
        • Locations
        • Data Breaches
        • Competitors
        • Blacklists
        • Twitter Engagement
        • News Articles
        • Operating Metrics (KPIs)
        • Sentiment Breakdowns
          • Sentiment Breakdown Item
            • Sentiment External Item
        • Sustainability Metrics
        • Technology Stack
        • Twitter Followers
        • Court Filings
        • Patents
        • Products and Services
        • Government Spending
        • Website Traffic
        • Compliance Data
        • Risks
    • GraphQL Enums
      • Unspsc Code Level Enum
      • Company Status Enum
      • Company Type Enum
      • Currency Type Enum
      • Metric Unit Enum
      • Period Type Enum
      • Sentiment Breakdown Type Enum
    • Core data types
      • String
      • Money Object
      • Source Object
      • Image Object
      • Period Object
      • Time Frame
      • AcurisAddress
      • AcurisAlias
      • AcurisBusinessLink
      • AcurisContactEntry
      • AcurisEvidence
      • AcurisGriEntry
      • AcurisIdentifier
      • AcurisIndividualLink
      • AcurisInsEntry
      • AcurisNote
      • AcurisPoiEntry
      • AcurisPosition
      • AcurisRegime
      • AcurisRelEntry
      • AcurisRelEvent
      • AcurisRelEventPeriod
      • AcurisRreEntry
      • AcurisRreEvent
      • AcurisSanEntries
      • AcurisSanEntry
      • AcurisSanEvent
      • AcurisSoeEntry
      • AcurisPepEntry
      • AcurisStatus
      • Risk
      • AdditionalInfo
      • RiskRating
      • RiskHighlight
      • RiskRatingInt
      • RiskRatingIntData
      • RiskRatingIntScaleItem
      • RiskRatingIntValueRange
      • RiskRatingFloat
      • RiskRatingFloatData
      • RiskRatingFloatScaleItem
      • RiskRatingFloatValueRange
      • ColorLinearGradient
      • RiskRatingString
      • RiskRatingStringData
      • RiskRatingStringScaleItem
    • Additional data types
      • PageInfo
    • Query examples
    • Restrictions on Usage
    • Usage
  • Added Companies API
    • Newly Profiled Companies API Introduction
    • Query
      • Basic Company
  • Alerts API
    • Alerts API Introduction
    • Getting started
      • Getting started with JavaScript
      • Getting started with Python
      • Getting started with Ruby
      • Getting started with cURL
    • Alerts API Queries
      • Pagination
      • Filtering and sorting
    • Alerts API Reference
      • Alert Object
      • Filter Object
      • Order Object
      • Payload Object
    • Query examples
    • Restrictions on Usage
Powered by GitBook
On this page

Was this helpful?

  1. Alerts API
  2. Alerts API Reference

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"
}
PreviousOrder ObjectNextQuery examples

Last updated 3 years ago

Was this helpful?