HTTP API - DeleteIndividual

Any user that you’ve identified with a user id can be removed from Fullstory using our API. You can also delete in the Fullstory UI with the click of a button if your use case doesn't require automation.

Use this feature to comply with Right to be Forgotten / Right to Erasure requests from your end users.

Note: This call requires an Admin and Admin API key.

Users API Endpoints

USER_ID is your own application specific ID you've given to the user. You will have passed that ID through the FS.identify() javascript API. You can find this in the user card in the Fullstory app.

Fetch user data

Fetch user data API call returns some data about a user given a user ID.

If you plan on deleting a user, it is recommended that you make this API call to verify that the user you’re about to delete is the one that you actually want to delete.

Example

$ curl -H 'Authorization: Basic YOUR_API_KEY' https://api.fullstory.com/users/v1/individual/10154

{
  "uid": "10154", 
  "displayName": "Daniel Falko", 
  "email": "daniel@falko.com", 
  "numSessions": "6", 
  "firstSeen": "2018-02-07T11:28:18.771Z", 
  "lastSeen": "2018-04-19T20:49:50.433Z"
}

Delete user

Delete user API call deletes all user data related to this user. This includes sessions, events and custom user variables, as well as all of the raw page files and any corresponding session data on our servers.

This is an asynchronous call in that it kicks off a background operation and returns immediately. It returns an operation ID that you can use to query the status of the operation later.

Example

$ curl -H 'Authorization: Basic YOUR_API_KEY' -X DELETE https://api.fullstory.com/users/v1/individual/10154

{
  "id": "YnVsa3k6NTc0OTU2MzMzMTcwNjg4MA=="
}

Operations API Endpoints

List all operations’ details

List operations API call returns an object containing a list of operation statuses and an optional pagination token that can be used for subsequent requests. The status information includes details like current state of the operation, estimate of percentage completed and the times when it was created and completed. The pagination token, if present, can be used to retrieve the next batch of results.

Example

$ curl -H 'Authorization: Basic YOUR_API_KEY' https://api.fullstory.com/operations/v1

{
  "operations": [
    {
      "id": "YnVsa3k6NTc0OTU2MzMzMTcwNjg4MA==", 
      "details": {
        "state": "COMPLETED", 
        "createdAt": "2018-04-19T22:40:52.174736Z", 
        "finishedAt": "2018-04-19T22:40:54.473657Z", 
        "estimatePctComplete": 100
      }
    },
    {
      "id": "YnVsa3k6NTcxNjY0NjcwMjM1MDMzNg==", 
      "details": {
        "state": "COMPLETED", 
        "createdAt": "2018-04-17T20:27:51.117302Z", 
        "finishedAt": "2018-04-17T20:27:54.589416Z", 
        "estimatePctComplete": 100
      }
    }
  ],
  “nextPaginationToken”: “aBgq12b90sd”
}

Get operation detail for one operation

Get operation API call returns the status of one particular operation given the operation ID.

Example

$ curl -H 'Authorization: Basic YOUR_API_KEY' https://api.fullstory.com/operations/v1/YnVsa3k6NTc0OTU2MzMzMTcwNjg4MA==

{
  "state": "COMPLETED", 
  "createdAt": "2018-04-19T22:40:52.174736Z", 
  "finishedAt": "2018-04-19T22:40:54.473657Z", 
  "estimatePctComplete": 100
}