Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Network Data Export API enables Viva Engage Verified Administrators to export all messages (including previous versions), files stored in Yammer, topics, users, and groups from a Viva Engage network. Data is exported as a ZIP file containing CSV files for each model and, if requested, file attachments.
You can perform a one-time export by specifying a date range, or set up recurring exports (daily or weekly) to meet compliance, analytics, or archival requirements.
Important
Daily exports are recommended instead of large, infrequent exports to reduce the risk of errors and improve reliability.
Key Features
- Comprehensive Export: Export all network data, including messages (and previous versions), files, topics, users, and groups.
- Flexible Scheduling: Perform one-time or recurring exports based on your busines needs.
- Granular Control: Specify which models to export and the date range for the export.
- External Groups and Users: Export all content for external groups and, for external users, only threads in which they participated.
Network Data Exports can also be performed via the Viva Engage admin portal: Yammer Network Admin > Content and Security > Export Data.
How the API Works
The Network Data Export API is synchronous. An HTTP GET request returns a ZIP file containing the requested data.
Example Requests
Export all data since February 9, 2020:
https://www.yammer.com/api/v1/export?since=2020-02-09T00:00:00+00:00
Export all data between February 9, 2020 and March 10, 2021:
https://www.yammer.com/api/v1/export?since=2020-02-09T00:00:00+00:00&until=2021-03-10T00:00:00+00:00
Export all data since February 9, 2020, excluding file attachments:
https://www.yammer.com/api/v1/export?since=2020-02-09T00:00:00+00:00&include=csv
Export only message data since February 9, 2020, excluding file attachments:
https://www.yammer.com/api/v1/export?since=2020-02-09T00:00:00+00:00&model=Message&include=csv
Query Parameters
model
: (Optional) Specify which models to export. If omitted, all available models are exported. Multiple models can be specified by repeating themodel
parameter. Available models include: User, Group, Message, MessageVersion, Topic, Tags, UploadedFileVersion, AMAs, AnswerVote, Campaigns, Leader, LikedMessageHistory, Sentie, VivaTopic, VivaTopicApplication, VivaTopicCurationStateLog.since
: (Required) Start date for the export (ISO-8601 format). All exported changes will have occurred on or after this date.until
: (Optional) End date for the export (ISO-8601 format). All exported changes will have occurred on or before this date. If omitted, defaults to the current date.include
: (Optional) Specify whether to include file attachments. Usecsv
to exclude attachments orall
to include them.network
: (Optional) Specify which network(s) to export. Must be accessible with the provided OAuth bearer token.include_ens
: (Optional) Iftrue
, includes all external networks associated with the authenticated network.
Ensure all parameters are properly URL-encoded before making the request.
API Response
The response is a ZIP file (application/zip
) containing the exported data. The ZIP file includes:
- CSV files for all or specifically requested models
log.txt
: Summary of the exportrequest.txt
: Parameters used for the export- File attachments (if requested and stored in Yammer)
CSV File Contents
Each CSV file contains data for a specific model. Below are some examples:
File | Description |
---|---|
log.txt | Summary of the export process. |
request.txt | Parameters used for the export. |
Admins.csv | List of current admins, their email addresses, and admin status. The CSV file contains the following columns:
|
AMAs.csv | Details of Ask Me Anything sessions. The CSV file contains the following columns:
|
AnswerVotes.csv | Votes on answers. The CSV file contains the following columns:
|
Campaigns.csv | Campaign details. The CSV file contains the following columns:
|
Files.csv | Metadata for files added or modified during the export period. Files.csv does not contain the actual files. Files stored in Yammer are exported in their native format to the Files folder of the zip file. Files stored in SharePoint are not exported. Files.csv contains the following columns:
|
Groups.csv | Group details, including privacy status and creation information. The CSV file contains the following columns:
|
LikedMessageHistory.csv | History of reactions to messages. Properties included for reactions activity including history:
|
Messages.csv | Messages sent or modified during the export period. The CSV file contains the following columns:
|
MessageThreadExtension.csv | Messages marked as best reply or verified reply. Properties include: - Message ID - Thread ID - Group ID - Network ID - Operation - Operation performed by - Operation performed at. |
MessageThreads.csv | Thread details for messages with external participants The CSV file contains the following columns:
|
MessageThreadOutbound.csv | Outbound message thread details, including external participants. The CSV file contains the following columns:
|
MessageVersions.csv | All versions of messages within the export period. The CSV file contains the following columns:
|
MutedThreads.csv | Threads that are muted for all users in the network. Properties include: network ID, thread ID, updated by user ID, is muted, created at, updated at. |
Networks.csv | Details of home and external networks included in the export. The CSV file contains the following columns:
|
Sentie.csv | Sentiment analysis data. The CSV file contains the following columns:
|
Topics.csv | Topic creation and metadata. The CSV file contains the following columns:
|
UserGroupRecommendationActions.csv | User group recommendation actions. The CSV file contains the following columns:
|
Users.csv | User data for all users who joined, were deleted, or suspended during the export period. The CSV file contains the following columns:
|
VivaEngageLeaders.csv | Viva Engage leader and audience information. The CSV file contains the following columns:
|
VivaTopicApplications.csv | Topic application details. The CSV file contains the following columns:
|
VivaTopicCurationStateLogs.csv | Curation state logs for featured topics. The CSV file contains the following columns:
|
VivaTopics.csv | Viva Topics created or updated during the export period. The id refers to the Viva Topic identifier. The api_url is the URL used to obtain the topic metadata. The CSV file contains the following columns:
|
For a detailed description of each CSV file and its columns, see the documentation above or within each file in the export.
Message Export Details
- Only message versions within the specified time range are exported.
- If a message's latest version is within the time range, it appears in both
Messages.csv
andMessageVersions.csv
. Older versions within the range appear only inMessageVersions.csv
.
Error Handling
If any data fails to export, the export will be partial. Details of any failures are recorded in log.txt
. To minimize the risk of partial exports, use smaller timeframes for each export.
Sample Code
Sample scripts for using the Network Data Export API with Unix and Windows PowerShell are available here. These samples are for illustration purposes only and are not intended for production use.