Skip to main content

AirQueries

Root type for AIR related queries.

type AirQueries {
  report(
    checkId: ID!
    timestamp: DateTime!
    forceRegenerate: Boolean = false
  ): AirReportStatePayload!
  reportStatus(
    checkId: ID!
    timestamp: DateTime!
  ): AirReportStatePayload!
  recommendationsForUser: AirRecommendationsPayload!
}

Fields​

AirQueries.report ● AirReportStatePayload! non-null object​

Get the AIR report generation status for a given check Id and timestamp. If forceRegenerate is true, a new report generation will be triggered.

NOTE: if the combination of checkId and timestamp does not exist, a NOTFOUND status will be returned.

AirQueries.report.checkId ● ID! non-null scalar​
AirQueries.report.timestamp ● DateTime! non-null scalar​
AirQueries.report.forceRegenerate ● Boolean scalar​

AirQueries.reportStatus ● AirReportStatePayload! non-null object​

Get the cached AIR report status for a given check ID and timestamp without triggering generation. Returns the current state from the cache (L1 memory or L2 database).

AirQueries.reportStatus.checkId ● ID! non-null scalar​
AirQueries.reportStatus.timestamp ● DateTime! non-null scalar​

AirQueries.recommendationsForUser ● AirRecommendationsPayload! non-null object​

Get intelligent home screen recommendations generated by AIR.

Returned By​

air query