ebay-api/lib/api/restful/sell/analytics/index.d.ts

eBay API for Node and Browser

import Restful from '../../index.js';
import { Metric } from '../../../../enums/index.js';
/**
 * The Analytics API provides information about a seller's business performance.
 */
export default class Analytics extends Restful {
    static id: string;
    get basePath(): string;
    /**
     * This call retrieves all the profiles for the associated seller.
     */
    findSellerStandardsProfiles(): Promise<any>;
    /**
     * This call retrieves seller's profiles based on a program or cycle.
     *
     * @param program Specifies the program of the requested profile.
     * @param cycle Specifies the cycle of the requested profile.
     */
    getSellerStandardsProfile(program: string, cycle: string): Promise<any>;
    /**
     * This call returns a report that details the user-traffic a seller's listings receives.
     *
     * @param dimension Specifies the basis of the report data.
     * @param filter Limits the report data returned.
     * @param metric Specifies a comma separated list of the metrics you want included in the report.
     * @param sort Specifies a single metric to be sorted and whether you want to sort in ascending or descending order.
     */
    getTrafficReport({ dimension, filter, metric, sort }?: {
        dimension?: string;
        filter?: string;
        metric?: Metric;
        sort?: string;
    }): Promise<any>;
    /**
     * Use this method to retrieve a seller's performance and rating for the customer service metric.
     *
     * @param customerServiceMetricType Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller.
     * @param evaluationType Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.
     */
    getCustomerServiceMetric(customerServiceMetricType: string, evaluationType: string): Promise<any>;
}