Client Notes

Learn how to add client notes when submitting a job via v1/queries endpoint.

You can add client_notes parameter when submitting a job via v1/queries endpoint. These client notes are then saved to database and to s3 storage along other job information.

Payload example

{
    "source": "universal",
    "url": "https://sandbox.oxylabs.io",
    "client_notes": "123456789"
}

Response example

{
    "callback_url": null,
    "client_id": 12345,
    ...
    "client_notes": "123456789",
    "_links": [
        {
            "rel": "self",
            "href": "http://data.oxylabs.io/v1/queries/7505247807800927233",
            "method": "GET"
        },
        {
            "rel": "results",
            "href": "http://data.oxylabs.io/v1/queries/7505247807800927233/results",
            "method": "GET"
        },
        {
            "rel": "results-content",
            "href_list": [
                "http://data.oxylabs.io/v1/queries/7505247807800927233/results/1/content"
            ],
            "method": "GET"
        },
        {
            "rel": "results-html",
            "href": "http://data.oxylabs.io/v1/queries/7505247807800927233/results?type=raw",
            "method": "GET"
        },
        {
            "rel": "results-content-html",
            "href_list": [
                "http://data.oxylabs.io/v1/queries/7505247807800927233/results/1/content?type=raw"
            ],
            "method": "GET"
        }
    ]
}