Table of contents

Saved Searches API

The saved searches API allows users to save a particular set of search parameters and easily run them again.

Get Saved Searches

GET /api/data/saved-searches

Sample response:

{
    "saved_searches": [
        {
            "saved_search_id": "5966c04e9480ef4d8dff09331af33755",
            "name": "Celebrities",
            "params": "query=Brad Pitt",
            "created_at": "2017-07-13T00:35:26.683471Z"
        },
        {
            "saved_search_id": "5966c06e5179ce3d6f384417722dea1a",
            "name": "Artwork",
            "params": "query=Britto",
            "created_at": "2017-07-13T00:35:58.368016Z"
        }
    ]
}

Add Saved Search

POST /api/data/saved-searches
{
    "name": "Celebrities",
    "params": "query=Brad Pitt"
}

• name - (string) Name of the saved search (must be unique)
• params - (string) url query params of search

Response:

{
    "saved_search_id": "5966c06e5179ce3d6f384417722dea1a",
    "name": "Artwork",
    "params": "query=Brad Pitt",
    "user_id": "59668a46d279dec1427c116d45ed910e",
    "created_at": "2017-07-13T00:35:58.368016Z"
}

Update Saved Search

PATCH /api/data/saved-searches/{saved_search_id}
{
    "params": "query=Brad Pitt"
}

• saved_search_id - (string) ID of the saved search to delete
• params - (string) url query params of the search to update

Response:

{
    "saved_search_id": "5966c06e5179ce3d6f384417722dea1a",
    "name": "Artwork",
    "params": "query=Brad Pitt",
    "user_id": "59668a46d279dec1427c116d45ed910e",
    "created_at": "2017-07-13T00:35:58.368016Z"
}

Delete Saved Search

DELETE /api/data/saved-searches/{saved_search_id}

• saved_search_id - (string) ID of the saved search to delete

Response:

{
    "saved_search_id": "5966b8013bba33d34663137071ecadcb",
    "deleted": true
}

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.

© 2021 GrayMeta, Inc.