Gong: List Multiple Users Aggregate By Period

Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period).

Tool ID: gong_list_multiple_users_aggregate_by_period

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_list_multiple_users_aggregate_by_period',
  {
    "filter": {
      "fromDate": "2026-01-15T12:00:00Z",
      "toDate": "2026-01-15T12:00:00Z"
    },
    "aggregationPeriod": "DAY"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute gong_list_multiple_users_aggregate_by_period --input '{
  "filter": {
    "fromDate": "2026-01-15T12:00:00Z",
    "toDate": "2026-01-15T12:00:00Z"
  },
  "aggregationPeriod": "DAY"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "requestId": "request_123",
    "records": {
      "totalRecords": 123,
      "currentPageSize": 123,
      "currentPageNumber": 123
    },
    "usersAggregateActivity": [
      {
        "userId": "user_123",
        "userEmailAddress": "jane.doe@example.com",
        "userAggregateActivity": [
          {}
        ]
      }
    ]
  }
}

Use deepline tools get gong_list_multiple_users_aggregate_by_period --json for the latest machine-readable contract.

Input reference

Returns aggregated statistics for team members’ actions on calls in Gong, grouped by the specified time period (aggregationPeriod). Each record shows the total number of activities performed within the fromDate–toDate range. If the same activity occurs in different periods, it’s counted separately. For example, if a team member listens to the same call on two different days, each day counts as one; listening to the same call twice on the same day counts as a single activity. Use the userIds field to retrieve data for specific team members. If userIds is empty, only team members with activity in the specified date range are returned. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
`payload.filter`	`object`	Yes	—	Filter parameters.
`payload.aggregationPeriod`	`"DAY" \| "WEEK" \| "MONTH" \| "QUARTER" \| "YEAR"`	Yes	—	Calendar time period for aggregating data. Note: First day of the week is Monday. Allowed: `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.requestId`	`string`	No	—	A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
`result.data.records`	`object`	No	—	Information about the number of records that match the requested filter.
`result.data.records.totalRecords`	`integer`	No	—	Total number of records. Format: `int32`.
`result.data.records.currentPageSize`	`integer`	No	—	Number of records in the current page. Format: `int32`.
`result.data.records.currentPageNumber`	`integer`	No	—	Current page number. Format: `int32`.
`result.data.records.cursor`	`string`	No	—	Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records.
`result.data.usersAggregateActivity`	`array`	No	—	A list, in which each item contains details of one user’s activities.
`result.data.usersAggregateActivity[].userId`	`string`	No	—	Gong’s unique numeric identifier for the user (up to 20 digits).
`result.data.usersAggregateActivity[].userEmailAddress`	`string`	No	—	The email address of the Gong user.
`result.data.usersAggregateActivity[].userAggregateActivity`	`array`	No	—	A list, in which each item contains aggregate user activity for consecutive time periods in the date range.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsAsHost`	`integer`	No	—	The number of recorded calls this user hosted. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsGaveFeedback`	`integer`	No	—	The number of recorded calls the user gave feedback on. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsRequestedFeedback`	`integer`	No	—	The number of recorded calls the user requested feedback on. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsReceivedFeedback`	`integer`	No	—	The number of recorded calls the user received feedback on. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].ownCallsListenedTo`	`integer`	No	—	The number of the user’s own calls the user listened to. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].othersCallsListenedTo`	`integer`	No	—	The number of other users’ calls the user listened to. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsSharedInternally`	`integer`	No	—	The number of calls the user shared with others inside the company. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsSharedExternally`	`integer`	No	—	The number of calls the user shared with others outside the company. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsScorecardsFilled`	`integer`	No	—	The number of scorecards the user completed. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsScorecardsReceived`	`integer`	No	—	The number of calls in which someone filled a scorecard on the user’s calls. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsAttended`	`integer`	No	—	The number of calls in which this user is participant (not host). Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsCommentsGiven`	`integer`	No	—	The number of calls in which a user gave at least one comment. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsCommentsReceived`	`integer`	No	—	The number of calls in which a user received at least one comment on the users calls. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsMarkedAsFeedbackGiven`	`integer`	No	—	The number of calls in which someone pressed the “Mark as reviewed”. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].callsMarkedAsFeedbackReceived`	`integer`	No	—	The number of calls in which someone pressed the “Mark as reviewed” on the users calls. Format: `int32`.
`result.data.usersAggregateActivity[].userAggregateActivity[].fromDate`	`string`	No	—	The start of the period, or the request filter’s fromDate for the first period in the range, in the ISO-8601 format, for example: ‘2024-01-17T16:20:05-03:00’ or ‘2016-02-16T03:57:04.834+05:30’ or ‘2020-11-20T21:30:07.233692Z’, where Z stands for UTC.
`result.data.usersAggregateActivity[].userAggregateActivity[].toDate`	`string`	No	—	The end of the period, or the request filter’s toDate for the last period in the range, in the ISO-8601 format, for example: ‘2024-01-17T16:20:05-03:00’ or ‘2016-02-16T03:57:04.834+05:30’ or ‘2020-11-20T21:30:07.233692Z’, where Z stands for UTC.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Gong: List Multiple Users Aggregate By Period

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation