Analytics Queries

These queries allow you to interact with analytics data.

analytics

Arguments

Argument	Type	Description
`endDate`	Date	End of date range
`fields`	[AnalyticsField]	Fields
`modifiers`	[AnalyticsFieldModifier]	Modifiers
`segment`	AnalyticsSegment	Segment
`startDate`	Date	Start of date range

Example Query

query(
  $endDate: Date,
  $fields: [AnalyticsField],
  $modifiers: [AnalyticsFieldModifier],
  $segment: AnalyticsSegment,
  $startDate: Date
) {
  analytics(
    endDate: $endDate,
    fields: $fields,
    modifiers: $modifiers,
    segment: $segment,
    startDate: $startDate
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "endDate": {},
  "fields": {},
  "modifiers": {},
  "segment": {},
  "startDate": {}
}

count

Returns: [AnalyticsDataRow]

Arguments

Argument	Type	Description
`breakdowns`	[AnalyticsBreakdown]	Breakdown categories for reporting
`endDate`required	Date!	End of date range
`field`required	AnalyticsField!	Field
`filters`	[Filter]	Filters
`segment`	AnalyticsSegment	Segment
`startDate`required	Date!	Start of date range

Example Query

query(
  $breakdowns: [AnalyticsBreakdown],
  $endDate: Date!,
  $field: AnalyticsField!,
  $filters: [Filter],
  $segment: AnalyticsSegment,
  $startDate: Date!
) {
  count(
    breakdowns: $breakdowns,
    endDate: $endDate,
    field: $field,
    filters: $filters,
    segment: $segment,
    startDate: $startDate
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "breakdowns": {},
  "endDate": {},
  "field": {},
  "filters": {},
  "segment": {},
  "startDate": {}
}

usageReport

Returns: UsageReport

Arguments

Argument	Type	Description
`breakdownByProvider`	Boolean	Group results by provider
`categoryIds`	[ID]	List of category IDs to filter by
`endDate`required	Date!	End of date range
`isReturned`	Boolean	Is returned
`locationIds`	[ID]	List of location IDs
`packageIds`	[ID]	List of package IDs
`productIds`	[ID]	List of product IDs
`startDate`required	Date!	Start of date range
`typeIds`	[ID]	List of type IDs

Example Query

query(
  $breakdownByProvider: Boolean,
  $categoryIds: [ID],
  $endDate: Date!,
  $isReturned: Boolean,
  $locationIds: [ID],
  $packageIds: [ID],
  $productIds: [ID],
  $startDate: Date!,
  $typeIds: [ID]
) {
  usageReport(
    breakdownByProvider: $breakdownByProvider,
    categoryIds: $categoryIds,
    endDate: $endDate,
    isReturned: $isReturned,
    locationIds: $locationIds,
    packageIds: $packageIds,
    productIds: $productIds,
    startDate: $startDate,
    typeIds: $typeIds
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "breakdownByProvider": true,
  "categoryIds": "1",
  "endDate": {},
  "isReturned": true,
  "locationIds": "1",
  "packageIds": "1",
  "productIds": "1",
  "startDate": {},
  "typeIds": "1"
}