Analytics Mutations

These mutations allow you to interact with analytics data.

downloadUsageReport

Returns: String

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
`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

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

Variables

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

emailUsageReport

Returns: Boolean

Arguments

Argument	Type	Description
`breakdownByProvider`	Boolean	Group results by provider
`categoryIds`	[ID]	List of category IDs to filter by
`emails`required	[String]!	List of email addresses
`endDate`required	Date!	End of date range
`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

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

Variables

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