> ## Documentation Index > Fetch the complete documentation index at: https://help.gong.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate) > Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user's activity. Required authorizaton scope: 'api:stats:user-actions'. ## OpenAPI ````json POST /v2/stats/activity/aggregate { "openapi": "3.0.1", "info": { "title": "Gong API", "version": "V2" }, "servers": [ { "url": "http://127.0.0.1:8090", "description": "Generated server url" } ], "tags": [ { "name": "Calls", "description": "

Gong’s “Calls” API endpoints allow you to:

\n\n

The requested calls may contain the following call details:

\n\n" }, { "name": "Users", "description": "

Gong’s “Users” API endpoints allow you to:

\n\n

The requested users may contain the following details:

\n\n" }, { "name": "Stats", "description": "

Gong’s “Stats” API endpoints allow you to:

\n\n

The requested user activity may contain the following details:

\n\n" }, { "name": "Settings", "description": "

Gong’s “Settings” API endpoints allow you to:

\n\n" }, { "name": "Data Privacy", "description": "

Gong’s “Data Privacy” API endpoints allow you to:

\n\n" }, { "name": "Library", "description": "

Gong’s “Library” API endpoints allow you to:

\n\n" }, { "name": "CRM", "description": "

If you are using the deprecated endpoints, download the PDF file.

What does the CRM API do?

This API enables integration with CRMs that are not natively integrated with Gong, so that Gong can provide you with its full capabilities based on your CRM data. This includes:

By uploading your CRM data to Gong, your Gong users will be able to see their CRM deals in the Gong Deals page, view deal boards to follow up on deal progress, get warnings for deals that are at risk, and see whether their team will reach its quota. The CRM data is also displayed in conversations and calls, so that your Gong users can see account and contact data such as the name and job title of the contact in the call. Account data is displayed in the Accounts page, together with the history of all communication and contact with the company.

Note: Gong provides native integrations with Salesforce, HubSpot and Microsoft Dynamics 365.

API Protocol

The API protocol is based on REST guidelines. Check here what's your base URL for all API calls.\n

The payload is either a JSON object or, for API calls that upload lists of objects, line delimited JSON (see: JSON streaming). JSON objects should be UTF-8 encoded.

Dates and timestamps in JSON objects should be in ISO-8601 format without milliseconds (e.g. '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).

What data can I upload?

To see your CRM data in Gong, upload the following entities:

Uploading CRM data to Gong

This diagram shows how to set up your system in order to upload CRM data to Gong. This is relevant for each scenario of uploading data, initial, incremental and uploading historical data.

\"\"

Registering your Integration

Register your integration to get an integrationId used to identify your company's integration with Gong. This is a one time action that does not need to be repeated unless you delete your integration.

Use PUT v2/crm/integrations to register your integration. The integration Id is returned in the response. Include the integration Id each time you upload your CRM data.

Uploading additional data for CRM entities

Each CRM entity has a set of standard fields. In addition, you may want to upload additional fields.

Use the POST /v2/crm/entity-schema to adjust the schema according to your needs. Once you have uploaded your schema to Gong, you can upload your entities with the additional fields.

Uploading your CRM data to Gong

This section explains how you can use the CRM API to upload your data to Gong:

First-time upload

Create a database dump of the data you want to upload to Gong based on your CRM schema and data. When uploading your data for the first time you should include all of the CRM records that should appear in Gong.

Incremental upload

Send regular incremental data updates to Gong. You can update your data as often as you like, we recommend updating between every 1-5 minutes.
You should only send new records or records that have changed since the previous upload of data. New records are added to Gong and existing records are updated or deleted, whichever is relevant. Entities are identified by the objectId. Ensure that this ID remains the same each time it is updated.

When updating data, the modificationDate parameter is mandatory. This enables us to maintain accurate historical data. If your CRM does not store the modification date, send the date the API call is made.

Uploading data change history

Gong incorporates historical change data in different areas of Gong in order to provide a more accurate picture of the status of different entities at that time. For example, showing the correct stage of a deal at the time a call was made.

If your CRM stores record history, you are encouraged to load historical change data as part of the integration. You can do this at any time, but we recommend doing this after the initial upload as follows:

  1. Generate the JSON files with the relevant data. Ensure that the modifiedDate is set to the date the entity was updated.
  2. Upload the entities with their historical data using the POST /v2/crm/entities?objectType=ACCOUNT|CONTACT|DEAL|LEAD endpoint.

Gong Data Model

This diagram shows the connection between the different objects in the CRM API:

\"\"

The following relationship between entities must exist:

What if my CRM doesn't match the Gong data model?

It is possible that your CRM entity model won't match the Gong CRM entity model. Your CRM may store your data in different entities, or you may not have an entity that represents one of the Gong CRM entities.

In order to upload your CRM data and associate it with calls and conversations, you need to identify the objects in your CRM which match the Gong CRM entities.

The account is a mandatory entity which must be uploaded in order to integrate Gong with your CRM. To upload account data, identify your CRM entities that contain data about your customers or companies that you do business with. These customers are not actual people within the org, rather they represent the org itself.

To upload contact details, identify your CRM entities that hold data about employees in the company that your reps are in touch with. A contact represents a person where communication has advanced beyond the prospect stage. Your reps will have multiple conversations and interactions with the contact.

The deal represents the selling process to the customer (account).

The lead is a prospect or potential contact, who is not yet associated with an account. If your CRM has an entity which represents people who you contact in the very early stages, and who is later converted to another entity which represents the people you are doing business with (the contact), upload this data as a lead entity.

When will my CRM data be displayed in Gong?

In addition to the time it takes for data to upload to Gong, the data is first uploaded as raw data and is not automatically available in Gong.





" }, { "name": "Auditing", "description": "

Gong’s “Auditing” API endpoints allow you to request the following log types from Gong:

\n\n" }, { "name": "Meetings (in Beta Phase)", "description": "

Gong’s “Consent Meeting” API endpoints allow you to:

\n\n

The requested calls may contain the following meeting details:

\n\n" }, { "name": "Permissions", "description": "

Gong’s \"Permission\" API endpoints allow you to:

\n\n" }, { "name": "Engage Flows", "description": "

Gong’s “Flows” API endpoints allow you to:

\n\n" }, { "name": "Digital Interactions", "description": "

Digital interactions (DIs) are events people make when interacting with (mostly) digital content. It can be described as an action someone did on an object. Anything from viewing a document or a video, to registering/completing a course or someone visiting your website.

The below proposed Digital Interactions API allows mainly tech-partners (and also customers) to capture and track user interactions with various types of digital content. It provides a structured schema for recording a person’s identity, action, content details, and additional contextual information. The API enables seamless integration between tech-partner systems and the Gong platform, providing valuable insights into buyer-seller interactions that sometimes are hidden from a seller’s line-of-sight.

For simplicity & clarity, the API scheme is designed according to a real-world scenario, including the following terminology:For simplicity & clarity, the API scheme is designed according to a real-world scenario, including the following terminology:

" }, { "name": "Integration Settings", "description": "

Configure your integration settings for displaying your company data in iFrames. For example, use this API to configure dynamic links as the iFrame source. This endpoint includes validation mechanisms to ensure the integration is secure.

Mandatory fields are marked with a *.

" }, { "name": "Engagement (Legacy – See “Digital Interactions”)", "description": "

Limited release - contact integration.requests@gong.io for more information.\n

\n\n

Gong’s \"Engagement\" API endpoints allow you to push engagement events into Gong and display them as events in Gong’s activity timeline.

\n

There are currently 3 types of events:

\n\n" } ], "paths": { "/v2/stats/activity/aggregate": { "post": { "operationId": "listMultipleUsersAggregateActivity", "summary": "Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate)", "description": "Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user's activity.\n\nRequired authorizaton scope: 'api:stats:user-actions'.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiBaseRequestV2MultipleUsersWithDates" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUsersAggregateActivityResponse" } } } }, "400": { "description": "Malformed request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "API request limit exceeded", "headers": { "Retry-After": { "description": "Number of seconds to wait before making a new request.", "style": "simple", "schema": { "type": "integer", "format": "int32" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Failed to complete the operation due to an unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Stats" ] } } }, "components": { "schemas": { "PublicApiBaseRequestV2MultipleUsersWithDates": { "type": "object", "properties": { "cursor": { "description": "When paging is needed, provide the value supplied by the previous API call to bring the following page of records.", "type": "string", "example": "eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM" }, "filter": { "$ref": "#/components/schemas/MultipleUsersWithDates" } }, "required": [ "filter" ] }, "CompanyUsersAggregateActivityResponse": { "type": "object", "properties": { "requestId": { "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.", "type": "string", "example": "4al018gzaztcr8nbukw" }, "records": { "$ref": "#/components/schemas/Records" }, "usersAggregateActivityStats": { "description": "A list, in which each item specifies one user's activities.", "type": "array", "items": { "$ref": "#/components/schemas/UserActivity" } }, "timeZone": { "description": "The company's defined timezone in Gong.", "type": "string", "example": "US/Pacific" }, "fromDateTime": { "description": "The date and time 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, when the list of results starts.", "type": "string", "example": "2019-01-20T08:00:00+00:00" }, "toDateTime": { "description": "The date and time 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, when the list of results ends.", "type": "string", "example": "2019-01-21T000:00:00-08:00" } } }, "ErrorResponse": { "type": "object", "properties": { "requestId": { "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.", "type": "string", "example": "4al018gzaztcr8nbukw" }, "errors": { "description": "Error messages.", "type": "array", "items": { "type": "string" }, "example": [ "An error has occurred" ] } } }, "MultipleUsersWithDates": { "description": "Filter parameters.", "type": "object", "properties": { "fromDate": { "description": "The date (in the company's time zone) from which to list a user's activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD.", "type": "string", "example": "2019-01-20" }, "toDate": { "description": "The date (in the company's time zone) until which to list a user's activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD.", "type": "string", "example": "2019-01-21" }, "createdFromDateTime": { "type": "string", "format": "date-time" }, "createdToDateTime": { "type": "string", "format": "date-time" }, "userIds": { "description": "Set of Gong's unique numeric identifiers for the users (up to 20 digits).", "type": "array", "items": { "type": "string" }, "example": [ "234599484848423" ], "uniqueItems": true, "writeOnly": true } }, "required": [ "fromDate", "toDate" ] }, "Records": { "description": "Information about the number of records that match the requested filter.", "type": "object", "properties": { "totalRecords": { "description": "Total number of records.", "type": "integer", "format": "int32", "example": 263 }, "currentPageSize": { "description": "Number of records in the current page.", "type": "integer", "format": "int32", "example": 100 }, "currentPageNumber": { "description": "Current page number.", "type": "integer", "format": "int32", "example": 0 }, "cursor": { "description": "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.", "type": "string", "example": "eyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM" } } }, "UserActivity": { "description": "A list, in which each item specifies one user's activities.", "type": "object", "properties": { "userId": { "description": "Gong's unique numeric identifier for the user (up to 20 digits).", "type": "string", "example": "234599484848423" }, "userEmailAddress": { "description": "The email address of the Gong user.", "type": "string", "example": "test@test.com" }, "userAggregateActivityStats": { "$ref": "#/components/schemas/AggregateActivity" } } }, "AggregateActivity": { "description": "Aggregated activity for a user within a time period", "type": "object", "properties": { "callsAsHost": { "description": "The number of recorded calls this user hosted.", "type": "integer", "format": "int32", "example": 20 }, "callsGaveFeedback": { "description": "The number of recorded calls the user gave feedback on.", "type": "integer", "format": "int32", "example": 35 }, "callsRequestedFeedback": { "description": "The number of recorded calls the user requested feedback on.", "type": "integer", "format": "int32", "example": 77 }, "callsReceivedFeedback": { "description": "The number of recorded calls the user received feedback on.", "type": "integer", "format": "int32", "example": 67 }, "ownCallsListenedTo": { "description": "The number of the user's own calls the user listened to.", "type": "integer", "format": "int32", "example": 668 }, "othersCallsListenedTo": { "description": "The number of other users' calls the user listened to.", "type": "integer", "format": "int32", "example": 96 }, "callsSharedInternally": { "description": "The number of calls the user shared with others inside the company.", "type": "integer", "format": "int32", "example": 478 }, "callsSharedExternally": { "description": "The number of calls the user shared with others outside the company.", "type": "integer", "format": "int32", "example": 75 }, "callsScorecardsFilled": { "description": "The number of scorecards the user completed.", "type": "integer", "format": "int32", "example": 876 }, "callsScorecardsReceived": { "description": "The number of calls in which someone filled a scorecard on the user's calls.", "type": "integer", "format": "int32", "example": 876 }, "callsAttended": { "description": "The number of calls in which this user is participant (not host).", "type": "integer", "format": "int32", "example": 46 }, "callsCommentsGiven": { "description": "The number of calls in which a user gave at least one comment.", "type": "integer", "format": "int32", "example": 21 }, "callsCommentsReceived": { "description": "The number of calls in which a user received at least one comment on the users calls.", "type": "integer", "format": "int32", "example": 13 }, "callsMarkedAsFeedbackGiven": { "description": "The number of calls in which someone pressed the \"Mark as reviewed\".", "type": "integer", "format": "int32", "example": 24 }, "callsMarkedAsFeedbackReceived": { "description": "The number of calls in which someone pressed the “Mark as reviewed” on the users calls.", "type": "integer", "format": "int32", "example": 35 } } } } } } ````