Skip to main content

ActivityMetricsInput

No description

input ActivityMetricsInput {
  event: String!
  libraryResourceId: String
  startDate: Datetime
  endDate: Datetime
  closedAtStartDate: Datetime
  closedAtEndDate: Datetime
  role: String
  groupBy: ActivityMetricsGroupBy
  aggregationLevel: ActivityMetricsAggregationLevel
  dealStages: [String!]
}

Fields​

ActivityMetricsInput.event ● String! non-null scalar​

Which report to run: "Resource Viewed" for views of the resource on an accord, or "Library Resource Viewed" for views on the library page. The library report reads only libraryResourceId, startDate and endDate; it ignores groupBy, aggregationLevel, role, closedAtStartDate and closedAtEndDate, always buckets by day, and collapses repeat views by the same viewer within 30 seconds.

ActivityMetricsInput.libraryResourceId ● String scalar​

The library resource to report activity for.

ActivityMetricsInput.startDate ● Datetime scalar​

Only count activity at or after this timestamp.

ActivityMetricsInput.endDate ● Datetime scalar​

Only count activity at or before this timestamp.

ActivityMetricsInput.closedAtStartDate ● Datetime scalar​

Only include accords whose close date is at or after this timestamp.

ActivityMetricsInput.closedAtEndDate ● Datetime scalar​

Only include accords whose close date is at or before this timestamp.

ActivityMetricsInput.role ● String scalar​

Restrict to viewers with this workspace-account role (e.g. only customers).

ActivityMetricsInput.groupBy ● ActivityMetricsGroupBy enum​

How to bucket each count; omit for a plain view count.

ActivityMetricsInput.aggregationLevel ● ActivityMetricsAggregationLevel enum​

Time bucket for the date axis; omit for a single ungrouped total, or pass an explicit null to bucket by month. Honored for "Resource Viewed" when grouping by DURATION or WORKSPACE_ACCOUNT, or with no groupBy; OPPORTUNITY_AMOUNT ignores it, and ACCORD errors if it is set at all.

ActivityMetricsInput.dealStages ● [String!] list scalar​

CRM deal stages to filter accords by, used when grouping by opportunity amount.

Member Of​

activityMetrics query