kustomer-client
    Preparing search index...

    Type Alias CustomerSearchData

    type CustomerSearchData = {
        body?: {
            aggs?: { [key: string]: unknown };
            and?: { [key: string]: unknown } | { [key: string]: unknown }[];
            fields?: { [key: string]: unknown }[];
            includeDeleted?: boolean;
            not?: { [key: string]: unknown } | { [key: string]: unknown }[];
            or?: { [key: string]: unknown } | { [key: string]: unknown }[];
            queryContext?: string;
            searchHash?: string;
            sort?: { [key: string]: unknown } | { [key: string]: unknown }[];
            timeZone?: string;
        };
        path?: never;
        query?: never;
        url: "/customers/search";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: {
        aggs?: { [key: string]: unknown };
        and?: { [key: string]: unknown } | { [key: string]: unknown }[];
        fields?: { [key: string]: unknown }[];
        includeDeleted?: boolean;
        not?: { [key: string]: unknown } | { [key: string]: unknown }[];
        or?: { [key: string]: unknown } | { [key: string]: unknown }[];
        queryContext?: string;
        searchHash?: string;
        sort?: { [key: string]: unknown } | { [key: string]: unknown }[];
        timeZone?: string;
    }

    Creates a query to retrieve the last updatedAt attribute to use in a subsequent request.

    {
    "and": [
    { "customer_updated_at": { "gte": "2016-01-01" } }
    ],
    "sort" : [{"customer_updated_at": "asc"}],
    "queryContext": "customer",
    "or":[]
    }

    Uses the returned updatedAt value from the previous request to page through all customer data and keep data up to date.

    {
    "and": [
    { "customer_updated_at": { "gte": "2016-07-27T22:30:48.939Z" } }
    ],
    "sort" : [{"customer_updated_at": "asc"}],
    "queryContext": "customer",
    "or":[]
    }
    path?: never
    query?: never
    url: "/customers/search"

    Settings

    Member Visibility

    On This Page

    Properties