DeleteDownloads

Command status: Active
Supported by OpenApps API: Yes
Supported by Enterprise API: Yes
Possibly queued processing: No

Call this function to Delete downloads when they fully finished and retrieved by you.

Parameter Description

cmd

Required: must be set to: DeleteDownloads

datasource

Optional - defaults to historic
Either: "fresh" - to query against fresh index, or "historic" - to query against historic index.

DownloadJobIDs

Required: One or more comma delimited DownloadJobID returned by DownloadBackLinks function.

Note: deletion of the download will not delete files that may have been uploaded to your own FTP (if it was specified). This deletion merely removes download from server database as if it was never requested. If the deletion is called during uploading phase then the server will automatically abort it, if its in processing stage then it will also be aborted.

https://api.majestic.com/api/xml?app_api_key=API_KEY&cmd=DeleteDownloads&DownloadJobIDs=1987812D694399622EDF6EB26D32C80E

Below you can see example of successful XML returned for this function:



https://api.majestic.com/api/json?app_api_key=API_KEY&cmd=DeleteDownloads&DownloadJobIDs=BE82255B70F2CD1DCC06762FA68BE9B9

Sample JSON response indicating that the job was deleted successfully:


Data table "DeletionResults" will contain rows with information on whether particular download request was deleted successfully or not (in case it does not exist or was deleted previously).

Common problems

Problem: not calling this function and thus keeping download in the downloads queue can prevent some commands such as AnalyseIndexItem from functioning correctly as they would assume that the job was already completed..
Solution: please call this function every time you have successfully downloaded!

For more information about access to the Majestic API suite, visit our Plans & Pricing page.