Sharing Analytics API \ Delete a Snapshot PHP SDK

Send a DELETE request to the following resource to delete an existing snapshot.

Resource/URI Advanced Sharing API Required GET POST PUT DELETE
Sharing Analytics Snapshots /sharing/analytics/snapshots.json List all snapshots Initiate a new snapshot
Sharing Analytics Snapshot /sharing/analytics/snapshots/<sharing_analytics_snapshot_token>.json Retrieve snapshot details Delete a snapshot

Workflow

Request: the code to send to the API

Send a DELETE to /sharing/analytics/snapshots/<sharing_analytics_snapshot_token>.json to immediately remove an existing snapshot. The <sharing_analytics_snapshot_token> has to be replaced by the unique token of an existing snapshot.

To prevent you from unintentionally deleting a snapshot by mixing up the DELETE/GET methods you have to include the url parameter confirm_deletion=true in your DELETE requests. If you omit this parameter, the user will not be deleted and an error will be thrown.

Result: the code returned by the API

If the snapshot has been deleted successfully, the API will return a HTTP status code 200. If the snapshot could not be deleted, the API will return an appropriate message body with further details on the error that occured.

Example Resultset

		{
		  "response": {
		    "request": {
		      "date": "Fri, 27 Jan 2012 16:24:15 +0100",
		      "resource": "/sharing/analytics/snapshots/a5de98a6-50cc-4d69-916a-d1e7ca9bafd0.json",
		      "status": {
		        "flag": "success",
		        "code": 200,
		        "info": "The sharing analytics snapshot has been deleted successfully"
		      }
		    }
		  }
		}

User Contributed Notes