Interface PlaceHistoryQueryOptions

Mapping of available query parameters for the history index endpoint

interface PlaceHistoryQueryOptions {
    actions?: string | string[];
    correlation_id?: string;
    exclude_resource_types?: string | string[];
    limit?: number;
    offset?: number;
    period_end?: number;
    period_start?: number;
    resource_id?: string;
    resource_types?: string | string[];
    user_id?: string;
}

Properties

actions? correlation_id? exclude_resource_types? limit? offset? period_end? period_start? resource_id? resource_types? user_id?

Properties

Optionalactions

actions?: string | string[]

Only return these kinds of change

Optionalcorrelation_id

correlation_id?: string

Only return changes related to this parent, i.e. a group, playlist or booking

Optionalexclude_resource_types

exclude_resource_types?: string | string[]

Exclude changes to these resource types (table names)

Optionallimit

limit?: number

Number of results to return. Defaults to 100. Max 10000

Optionaloffset

offset?: number

Offset of the results to return

Optionalperiod_end

period_end?: number

Only return changes made before this time, as a unix epoch in seconds

Optionalperiod_start

period_start?: number

Only return changes made at or after this time, as a unix epoch in seconds

Optionalresource_id

resource_id?: string

Only return changes to this resource, usually combined with resource_types

Optionalresource_types

resource_types?: string | string[]

Only return changes to these resource types (table names)

Optionaluser_id

user_id?: string

Only return changes made by this user

Settings

Member Visibility

On This Page

Properties