Workplace

Data Export

Path /{export-job-id}

Represents a data export job. The /{export-job-id} node returns export job data. An {export-job-id} can be obtained by scheduling an export job. See the Scheduling a data export job section below for the different job types and how to schedule them.

Reading

You can read information about a data export job by making a Graph API GET request to /{export-job-id}.

Permissions

Reading a data export job node requires the relevant permission for the data being exported. See job types below for specific permissions.

Data export jobs are not compatible with group-scoped integrations. Please ensure that the integration being used to schedule export jobs has the group scoping set to "All groups".

Fields

Field NameDescriptionData Type

id

The data export job ID

string

status

Indicates the status of the data export job

enum {PENDING, STARTED, COMPLETED, FAILED}

type

The type of data export job. See below for details.

string

result

Temporary URI to download a XLSX with results

string

Scheduling a data export job

Employee data export (Job type: WORK_FILE_EXPORT_USER)

This job type provides the list of current employees and their activity data in a XLSX format. It can be scheduled by making a POST request to /community/export_employee_data. It is not necessary to provide any other data with this request. The only data returned is the export job ID which can then be used to retrieve the exported data, as described above.

Permissions

The Employee data export job type requires the Export employee data permission

Data export contents

The resulting data file contains the following data:

  • Full name
  • Email
  • Employee ID
  • Job title
  • Department
  • Division
  • Organisation
  • Phone number
  • Location
  • Start date
  • Admin
  • Source
  • Creation data
  • Claimerd
  • Claim date
  • Claim link
  • Status
  • Invited date
  • Manage email
  • Manager employee ID
  • Has profile
  • Followers
  • Login approval enabled
  • Frontline
  • Activity summary for date
  • Active in the Last 28 Days
  • Active in the Last Week
  • Active in the Last Day
  • Active in the Last 28 Days on Workplace Mobile App
  • Active in the Last Week on Workplace Mobile App
  • Active in the Last Day on Workplace Mobile App
  • Messages in the Last 28 Days
  • Messages in the Last Week
  • Messages in the Last Day
  • Post in the Last 28 Days
  • Post in the Last Week
  • Post in the Last Day
  • Comment in the Last 2 Years
  • Comment in the Last Week
  • Comment in the Last Day
  • Reactions in the Last 28 Days
  • Reactions in the Last Week
  • Reactions in the Last Day
  • Contributor Score in the Last 28 Days
  • Contributor Score in the Last Week
  • Contributor Score in the Last Day

Deleting

A data export job cannot be deleted.

Updating

A data export job cannot be updated.

Examples

Schedule and read an Employee Data Export job

POST /community/export_employee_data HTTP/1.1
        Host: graph.facebook.com    
        
GET /{export_job_id} HTTP/1.1
        Host: graph.facebook.com