Skip to Content
API Reference/v1/history/{search-id}

Search History by ID

Description

This endpoint is used to provide the client the actual results data that corresponds to a given past search identifier. Moreover, it may also be used to delete the search from the user’s history. Refer to Search History for a deeper dive.

It is available at the following URL.

https://api.intelsentry.io/v1/history/{search-id}

Input Params

search-id: Request path parameter that corresponds to the identifier of the search, gotten previously from the /v1/history endpoint.

HTTP Methods

  • GET: Used to retrieve the results of the search.
  • DELETE: Used to delete the search from the user’s history.

Example Request (GET)

GET https://api.intelsentry.io/v1/history/2f2fb1ed-72d1-46d3-9929-d0f482d85772
Authorization: Bearer <token>

Example Request (DELETE)

DELETE https://api.intelsentry.io/v1/history/2f2fb1ed-72d1-46d3-9929-d0f482d85772
Authorization: Bearer <token>

Example Response (GET)

HTTP/1.1 200
Content-Type: application/json
 
{
    "status": 200,
    "results": [
        "https://login.example.com/:redacted@example.com:redacted",
        "https://login.example.com/login.srf:redacted@gmail.com:redacted",
        "https://account.example.com/ResetPassword.aspx:redacted:redacted.com123"
    ],
    "results_count": 3
}

Note that results is a JSON string array containing the actual list of compromised credentials. Moreover, results_count corresponds to the length of the array.

Example Response (DELETE)

HTTP/1.1 200
Content-Type: application/json
 
{
    "status": 200,
    "result": "Search successfully deleted from history"
}

Note that you won’t be able to access the deleted search data anymore. Moreover, if you try to delete it a second time, you will get the following response.

HTTP/1.1 400
Content-Type: application/json
 
{
    "status": 400,
    "error": "Search not found in history"
}

Status Codes (GET)


Status CodeDescription
200The search results were correctly returned
400The search does not exist in the user’s history

Status Codes (DELETE)


Status CodeDescription
200The search was correctly deleted from the history
400The search does not exist in the user’s history
Last updated on
/v1/history