Azure Connectors Node.js SDK
    Preparing search index...

    Options for the getEvents operation.

    interface GetEventsOptions {
        abortSignal?: AbortSignalLike;
        attractionId?: string;
        city?: string[];
        classificationId?: string[];
        classificationName?: string[];
        collectionId?: string[];
        countryCode?: string;
        dmaId?: string;
        domain?: string[];
        endDateTime?: string;
        genreId?: string[];
        geoPoint?: string;
        id?: string;
        includeFamily?: string;
        includeSpellcheck?: string;
        includeTba?: string;
        includeTbd?: string;
        includeTest?: string;
        keyword?: string;
        latlong?: string;
        locale?: string;
        localStartDateTime?: string[];
        localStartEndDateTime?: string[];
        marketId?: string;
        onResponse?: ConnectorRawResponseCallback;
        onsaleEndDateTime?: string;
        onsaleOnAfterStartDate?: string;
        onsaleOnStartDate?: string;
        onsaleStartDateTime?: string;
        page?: string;
        postalCode?: string;
        preferredCountry?: string;
        preSaleDateTime?: string[];
        promoterId?: string;
        publicVisibilityStartDateTime?: string[];
        radius?: string;
        segmentId?: string[];
        segmentName?: string[];
        size?: number;
        sort?: string;
        source?: string;
        startDateTime?: string;
        startEndDateTime?: string[];
        stateCode?: string;
        subGenreId?: string[];
        subTypeId?: string[];
        tracingOptions?: OperationTracingOptions;
        typeId?: string[];
        unit?: string;
        venueId?: string;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    attractionId?: string

    The filter by attraction identifier.

    city?: string[]

    The filter by city.

    classificationId?: string[]

    The filter by classification identifier: identifier of any segment, genre, sub-genre, type, sub-type.

    classificationName?: string[]

    The filter by classification name: name of any segment, genre, sub-genre, type, sub-type.

    collectionId?: string[]

    The filter by collection identifier.

    countryCode?: string

    The filter by country code.

    dmaId?: string

    The filter by DMA identifier.

    domain?: string[]

    The filter for entities based on domains they are available on.

    endDateTime?: string

    The filter with a start date before this date.

    genreId?: string[]

    The filter by genre identifier.

    geoPoint?: string

    The filter for events by geoHash.

    id?: string

    The filter for entities by their identifier.

    includeFamily?: string

    The filter by classification that are family-friendly.

    includeSpellcheck?: string

    Indicates whether to include spell check suggestions in the response.

    includeTba?: string

    Indicates whether to include events with date to be announced (TBA).

    includeTbd?: string

    Indicates whether to include events with a date to be defined (TBD).

    includeTest?: string

    Indicates whether to include entities flagged as test in the response.

    keyword?: string

    The keyword to search on.

    latlong?: string

    The filter for events by latitude and longitude. This filter is deprecated and may be removed in a future release, please use geoPoint instead.

    locale?: string

    The locale in ISO code format. Multiple comma-separated values can be provided.

    localStartDateTime?: string[]

    The filter with event local start date time within this range.

    localStartEndDateTime?: string[]

    The filter for events where event local start and end date overlap this range.

    marketId?: string

    The filter by market identifier.

    Callback invoked with the complete response before the operation returns or throws.

    onsaleEndDateTime?: string

    The filter with onsale end date before this date.

    onsaleOnAfterStartDate?: string

    The filter with onsale range within this date.

    onsaleOnStartDate?: string

    The filter with onsale start date on this date.

    onsaleStartDateTime?: string

    The filter with onsale start date after this date.

    page?: string

    The page number.

    postalCode?: string

    The filter by postal code or zipcode.

    preferredCountry?: string

    The popularity boost by country, default is us.

    preSaleDateTime?: string[]

    The filter for events with a presale start and end that intersects with this range.

    promoterId?: string

    The filter by promoter identifier.

    publicVisibilityStartDateTime?: string[]

    The filter for events with public visibility starting.

    radius?: string

    The radius of the area in which we want to search for events.

    segmentId?: string[]

    The filter by segment identifier.

    segmentName?: string[]

    The filter by segment name.

    size?: number

    The page size of the response.

    sort?: string

    The sorting order of the search result.

    source?: string

    The filter for entities by their primary source name or publishing source name.

    startDateTime?: string

    The filter with a start date after this date.

    startEndDateTime?: string[]

    The filter for events where event start and end date overlap this range.

    stateCode?: string

    The filter by state code.

    subGenreId?: string[]

    The filter by sub-genre identifier.

    subTypeId?: string[]

    The filter by sub-type identifier.

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.

    typeId?: string[]

    The filter by type identifier.

    unit?: string

    The unit of the radius.

    venueId?: string

    The filter by venue identifier.