@yext/search-core/dist/commonjs/src/models/searchservice/response/FailedVertical.d.ts

Typescript Networking Library for the Yext Search API

import { ErrorType } from './ErrorType';
/**
 * Error information from when a vertical fails to return results.
 *
 * @public
 */
export interface FailedVertical {
    /** The vertical key associated with the failed vertical. */
    verticalKey: string;
    /** {@inheritDoc ErrorType} */
    errorType: ErrorType;
    /** The duration of the query in milliseconds. */
    queryDurationMillis: number;
    /** Detailed information about the error. */
    details: {
        /**
         * An HTTP response status code indicating the completion status of
         * the request.
         */
        responseCode: number;
        /** A message explaining the error. */
        description: string;
    };
}