Activity Export API
This API lets customers of the Inspect Module pull activity data associated with Accounts and Opportunities. You can pull data to use in the BI tools of your choice for reporting and analytics.
Access to this API requires a subscription to either the Data Automation & Engagement (DAE) or Capture modules. If you’re unsure whether your account includes these entitlements, please reach out to your Clari account team for confirmation.
Access the API
1. To use the activity export API, generate an authentication token. See this article for more info.
2. Once you generate the token, use the instructions here in the Developer Portal to access the API and pull the activity data.
3. Once the export job is triggered, a JSON formatted response provides data like this example:
|
Property
|
Type
|
Description
|
Example
|
|
activityId
|
String
|
Unique identifier for each activity record
|
58eaf6bae6bdab17f362400127170cc3
|
|
activityType
|
String
|
Type of activity record (i.e. MEETING, EMAIL_SENT)
|
MEETING
|
|
subject
|
String
|
Subject of the activity
|
Data Pulse <> Clari Sync
|
|
date
|
Integer
|
Date/time as an epoch timestamp on which activity occurred or occurs
|
1702906200000
|
|
activityOwnerId
|
String
|
Salesforce ID of user whose inbox or calendar the activity is indexed from
|
0073x000005ChMyQKK
|
|
activityOrganiserId
|
String
|
Salesforce ID of the user who organized or created the activity
|
0044x000005ChMyQQA
|
|
Accounts
|
Array
|
List of accounts to which the activity is mapped
|
|
|
accountId
|
String
|
Salesforce account ID
|
0014x000018I6EVAA0
|
|
accountName
|
String
|
Name of the account
|
Data Pulse FY24
|
|
accountOwnerId
|
String
|
Salesforce account owner ID
|
0073x000005ChMyQKK
|
|
Opportunities
|
Array
|
List of opportunities to which the activity is mapped
|
|
|
opportunityId
|
String
|
Salesforce opportunity ID
|
0064x00000MaqIEAAZ
|
|
opportunityName
|
String
|
Name of the opportunity
|
Data Pulse FY24
|
|
opportunityOwnerId
|
String
|
Salesforce opportunity owner ID
|
0073x000005ChMyQKK
|
|
Participants
|
Array
|
List of participants in the activity
|
|
|
name
|
String
|
Name of the participant
|
Ava Turner
|
|
email
|
String
|
Email address of the participant
|
aturner@internaldomain.com
|
|
sfdcUserId
|
String
|
Salesforce user ID of the participant (empty for external participants)
|
0073x000005ChMyQKK
|
|
isInternal
|
Boolean
|
Shows whether the participant is an internal user or not
|
true
|
FAQs
What are the input parameters for the export API?
You can choose a date range and specify activity type to export—like meetings, sent emails, etc.
What data formats are supported with the export API?
JSON format
What activity types are supported by the export API?
The export API supports "MEETING", "EMAIL_SENT", "EMAIL_ATTACHED", "ATTACHMENT_SENT", "ATTACHMENT_RECEIVED"
What data formats are supported with the export API?
JSON format
What date formats are supported with the export API?
Both the start date and end date should be in ISO date-time format.
Are the activities that are not matched to an account or opportunity considered for the export?
No, the export only includes activities matched to accounts or opportunities.
