View source for Importing and exporting data using APIs

Importing and exporting data using APIs / ← Workforce Intelligence APIs

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in one of the groups: Users, editor, pegaemployee.
• The action you have requested is limited to users in one of the groups: pegaemployee, editor, Administrators.

---

You can view and copy the source of this page.

=== '''<big>Export API</big>''' === From the Workforce Intelligence Portal, users assigned to the analyst role can download different types of data exports which are available in comma-separated value (.CSV) format. There are two ways to access the data exports. An application user with analyst role can manually download the data exports from the '''Analysis''' '''>''' '''Exports''' menu option on the portal or these exports can be accessed via export API. The different types of data exports available to a client are: # Weekly or monthly aggregate data exports # Default data export which can contain one or more types of data exports in a zipped file - #* Detailed daily raw data exports (High-Level data export) #* User’s hierarchy data export #* Processed export #* Workflow export #* Step export # Custom data exports Note 1: You can enable either a weekly export or a monthly data export. Both exports cannot be enabled at the same time. Once the weekly or monthly and or default data export files are created, the data pipeline will not update or modify the historical export files. Note 2: Default data exports are disabled by default. Clients can select (from above) which default data export they need. To request the different default data exports, clients will need to request them from My Support Portal. Due to the size of these exports, clients might find the export API to be the preferable download method to gain access to the data to create their own reports and visualizations. After the Service Delivery team enables the requested exports, clients can use the Export API to create scripts to download and access the different types of data exports available to them. Clients can schedule and automate the export, download, and designate a centralized location to save the download. '''Sample API call for a weekly data export''' '''(if weekly data export is enabled)''' - <code>https://'''clientname'''.wfi.pega.com/api/v1/s3-exports/download?fileName='''exports/pega-wfi-clientname_Data_Export_Weekly_20211024.csv'''</code> '''Sample API call for a monthly data export (if monthly data export is enabled)''' - <code>https://'''clientname'''.wfi.pega.com/api/v1/s3-exports/download?fileName='''exports/pega-wfi-clientname_Data_Export_Monthly_202009.csv'''</code> '''Sample API call for a default data''' - <code>https://'''clientname'''.wfi.pega.com/api/v1/s3-exports/download?fileName='''daily-event-exports/20211014-default-clientname.zip'''</code> Note: In the Workforce Intelligence 8.7 release, the default data export filename and extension changed to “.zip”. The zipped file contains individual “.CSV” files for event, processed, step, user, or workflow exports. ==== '''Custom data exports''' ==== Introduced in Workforce Intelligence release 8.7, if an analyst sees a metric in the Workforce Intelligence application, then we can include it in a custom data export. Clients need to create a Service Request through My Support Portal (<nowiki>https://msp.pega.com</nowiki>) to have a custom export built. Like default data exports, custom data exports will be generated daily, and they can be accessed via '''Analysis''' '''>''' '''Exports''' or through Export API. ''Note: At this time, we cannot do more than a single day at a time.'' Examples of some custom data export which Service Delivery team can build are: * Administrator audit log * Screen Rules export '''Sample API call for a custom data export -''' <code>https://'''clientname'''.wfi.pega.com/api/v1/s3-exports/download?fileName='''daily-event-exports/20211014-custom-clientname.zip'''</code> Due to the detailed nature of the daily raw data export, it is recommended that you see the [https://community.pega.com/knowledgebase/articles/pega-workforce-intelligence/high-level-events data dictionary of high-level events], which is available on Pega Community. '''Weekly data export report example.''' This format is an exact duplicate of the portal report pulled using the manual download method: [[File:Weekly_Data_Export.jpg|alt=|border|frameless|996x996px]] '''User hierarchy data export example''' [[File:User hierarchy.jpg|frame|alt=|border|none]] '''Workflow data export example''' [[File:Workflow 1.jpg|frame|alt=|border|none]] [[File:Workflow 2.jpg|frame|alt=|border|none]] '''Step data export example'''[[File:Step 1.jpg|alt=|none|frame]] [[File:Step 2.jpg|left|frame|alt=|border]] [[File:Step 3.jpg|frame|alt=|border|none]]

Return to Workforce Intelligence APIs.