Interface SearchRequest

interface SearchRequest {
    customFields?: Admin.CustomField.Request[];
    endDate?: string | Date;
    size?: number;
    sortDirection?: SortDirection;
    sortField?: SortField;
    startDate?: string | Date;
}

Properties

customFields? endDate? size? sortDirection? sortField? startDate?

Properties

OptionalcustomFields

customFields?: Admin.CustomField.Request[]

List of custom fields to use when searching for events. All of the fields provided are concatenated as AND in the search request. The value to the property 'Value' is required.

OptionalendDate

endDate?: string | Date

Search parameter to use to match those events that are set to start on or before the date specified. Value should be greater than or equal to startDate. If not specified, it assumes a value of the current date.

Optionalsize

size?: number

Number of records in the dataset to return per search request. Default is 100, minimum is 50 and maximum is 500.

OptionalsortDirection

sortDirection?: SortDirection

Sort direction of the dataset. Values supported: 'asc' and 'desc'. Default is 'asc'.

OptionalsortField

sortField?: SortField

Name of the field in the event that will be used to sort the dataset in the response. Default is 'StartDate'

OptionalstartDate

startDate?: string | Date

Search parameter to use to match those events that are set to start on or after the date specified. Value should be less than or equal to endDate. If not specified, it assumes a value of endDate - 365 days.

Settings

Member Visibility

On This Page

Properties