get-identity-buckets.md

UID2 API Documentation > v1 > Endpoints > GET /identity/buckets

GET /identity/buckets

Monitor rotated salt buckets. This endpoint is intended for use by Advertisers/Data Providers.

NOTE: No salt buckets will be rotated until January 12, 2022. Any requests prior to January 12, 2022, will return an empty response body.

Request Format

GET '{environment}/{version}/identity/buckets?since_timestamp={queryParameterValue}'

Path Parameters

Path Parameter	Data Type	Attribute	Description
{environment}	string	Required	Testing environment: https://integ.uidapi.com Production environment: https://prod.uidapi.com
{version}	string	Required	The current API version is v1.

Query Parameters

Query Parameter	Data Type	Attribute	Description	Format
since_timestamp	date-time or integer	Required	Specify the date and time to which to compare the last updated UTC timestamps of the buckets to be returned.	ISO 8601 format: YYYY-MM-DDThh:mm:ss Ensure that the parameter value is URL-encoded.

Request Example

curl -L -X GET 'https://integ.uidapi.com/v1/identity/buckets?since_timestamp=2021-03-01T01%3A01%3A01' -H 'Authorization: Bearer YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk='

Response Format

The response returns a list of salt bucket IDs and the timestamps of their last updates.

{
    "body":[
        {
            "bucket_id":"a3pPl64opk",
            "last_updated":"2021-03-01T00:00:00"
        },
        {
            "bucket_id":"aENdq9K3VQ",
            "last_updated":"2021-03-01T00:00:00"
        },
        {
            "bucket_id":"adVEM9ywVo",
            "last_updated":"2021-03-01T00:00:00"
        }
    ],
    "status":"success"
}

Response Body Properties

Property	Format	Description
bucket_id	string	The salt bucket ID.
last_updated	date-time	The UTC timestamp of the last time the bucket salt was rotated.

For response status values, see Response Structure and Status Codes.