{"files":{"SKILL.md":"---\nname: analytics-api\ndescription: \"Analytics API skill. Use when working with Analytics for customer_service_metric, seller_standards_profile, traffic_report. Covers 4 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# Analytics API\nAPI version: 1.3.2\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://api.ebay.com/sell/analytics/v1\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /seller_standards_profile -- this call retrieves all the standards profiles for the associated seller.  a standards profile  is a set of ebay seller metrics and the seller's associated compliance values (either top_rated, above_standard, or below_standard).  a seller's multiple profiles are distinguished by two criteria, a \"program\" and a \"cycle.\" a profile's program  is one of three regions where the seller may have done business, or program_global to indicate all marketplaces where the seller has done business. the cycle value specifies whether the standards compliance values were determined at the last official ebay evaluation or at the time of the request.\n3. Explore available endpoints below\n\n## Endpoints\n4 endpoints across 3 groups. See references/api-spec.lap for full details.\n\n### Customer_service_metric\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /customer_service_metric/{customer_service_metric_type}/{evaluation_type} | Use this method to retrieve a seller's performance and rating for the customer service metric.  Control the response from the getCustomerServiceMetric method using the following path and query parameters: customer_service_metric_type controls the type of customer service transactions evaluated for the metric rating. evaluation_type controls the period you want to review. evaluation_marketplace_id specifies the target marketplace for the evaluation. Currently, metric data is returned for only peer benchmarking. For details on the workings of peer benchmarking, see Service metrics policy.  For details on using and understanding the response from this method, see Interpreting customer service metric ratings. |\n\n### Seller_standards_profile\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /seller_standards_profile | This call retrieves all the standards profiles for the associated seller.  A standards profile  is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).  A seller's multiple profiles are distinguished by two criteria, a \"program\" and a \"cycle.\" A profile's program  is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation or at the time of the request. |\n| GET | /seller_standards_profile/{program}/{cycle} | This call retrieves a single standards profile for the associated seller.  A standards profile  is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).  A seller can have multiple profiles distinguished by two criteria, a \"program\" and a \"cycle.\" A profile's program  is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation (CURRENT) or at the time of the request (PROJECTED). Both cycle and a program values are required URI parameters for this method. |\n\n### Traffic_report\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /traffic_report | This method returns a report that details the user traffic received by a seller's listings. A traffic report gives sellers the ability to review how often their listings appeared on eBay, how many times their listings are viewed, and how many purchases were made. The report also returns the report's start and end dates, and the date the information was last updated.  For more information, see Traffic report details |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Get customer_service_metric details?\" -> GET /customer_service_metric/{customer_service_metric_type}/{evaluation_type}\n- \"List all seller_standards_profile?\" -> GET /seller_standards_profile\n- \"Get seller_standards_profile details?\" -> GET /seller_standards_profile/{program}/{cycle}\n- \"List all traffic_report?\" -> GET /traffic_report\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Analytics API\n@base https://api.ebay.com/sell/analytics/v1\n@version 1.3.2\n@auth OAuth2\n@endpoints 4\n@toc customer_service_metric(1), seller_standards_profile(2), traffic_report(1)\n\n@group customer_service_metric\n@endpoint GET /customer_service_metric/{customer_service_metric_type}/{evaluation_type}\n@desc Use this method to retrieve a seller's performance and rating for the customer service metric.  Control the response from the getCustomerServiceMetric method using the following path and query parameters: customer_service_metric_type controls the type of customer service transactions evaluated for the metric rating. evaluation_type controls the period you want to review. evaluation_marketplace_id specifies the target marketplace for the evaluation. Currently, metric data is returned for only peer benchmarking. For details on the workings of peer benchmarking, see Service metrics policy.  For details on using and understanding the response from this method, see Interpreting customer service metric ratings.\n@required {customer_service_metric_type: str # Use this path parameter to specify the type of customer service metrics and benchmark data you want returned for the seller. Supported types are: ITEM_NOT_AS_DESCRIBEDITEM_NOT_RECEIVED, evaluation_marketplace_id: str # Use this query parameter to specify the Marketplace ID to evaluate for the customer service metrics and benchmark data.  For the list of supported marketplaces, see Analytics API requirements and restrictions. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/bas:MarketplaceIdEnum, evaluation_type: str # Use this path parameter to specify the evaluation period to use for the performance metrics. See  EvaluationTypeEnum for more information on the supported values.}\n@returns(200) {dimensionMetrics: [map], evaluationCycle: map{endDate: str, evaluationDate: str, evaluationType: str, startDate: str}, marketplaceId: str} # Success\n@errors {400: Bad Request, 404: Resource not found. Invalid path parameters., 409: Conflict, 500: Internal Server Error}\n\n@endgroup\n\n@group seller_standards_profile\n@endpoint GET /seller_standards_profile\n@desc This call retrieves all the standards profiles for the associated seller.  A standards profile  is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).  A seller's multiple profiles are distinguished by two criteria, a \"program\" and a \"cycle.\" A profile's program  is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation or at the time of the request.\n@returns(200) {standardsProfiles: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endpoint GET /seller_standards_profile/{program}/{cycle}\n@desc This call retrieves a single standards profile for the associated seller.  A standards profile  is a set of eBay seller metrics and the seller's associated compliance values (either TOP_RATED, ABOVE_STANDARD, or BELOW_STANDARD).  A seller can have multiple profiles distinguished by two criteria, a \"program\" and a \"cycle.\" A profile's program  is one of three regions where the seller may have done business, or PROGRAM_GLOBAL to indicate all marketplaces where the seller has done business. The cycle value specifies whether the standards compliance values were determined at the last official eBay evaluation (CURRENT) or at the time of the request (PROJECTED). Both cycle and a program values are required URI parameters for this method.\n@required {cycle: str # This path parameter is used to specify the cycle for which metrics and metadata will be retrieved.See CycleTypeEnum for a list of supported values., program: str # This path parameter is used to specify the seller standards program for which metrics and metadata will be retrieved. See ProgramEnum for a list of supported values.}\n@returns(200) {cycle: map{cycleType: str, evaluationDate: str, evaluationMonth: str}, defaultProgram: bool, evaluationReason: str, metrics: [map], program: str, standardsLevel: str} # Success\n@returns(204) No content\n@errors {400: Bad Request, 404: Resource not found, 500: Internal Server Error}\n\n@endgroup\n\n@group traffic_report\n@endpoint GET /traffic_report\n@desc This method returns a report that details the user traffic received by a seller's listings. A traffic report gives sellers the ability to review how often their listings appeared on eBay, how many times their listings are viewed, and how many purchases were made. The report also returns the report's start and end dates, and the date the information was last updated.  For more information, see Traffic report details\n@optional {dimension: str # This query parameter specifies the dimension, or \"attribute,\" that is applied to the report metric.  Valid values: DAY or LISTING  Examples If you specify dimension=DAY and metric=CLICK_THROUGH_RATE, the traffic report contains the number of times an item displayed on a search results page and the buyer clicked through to the View Item page for each day in the date range, as in: 12-06-17: 32, 12-07-17: 54, ... If you specify dimension=LISTING and metric=LISTING_IMPRESSION_STORE, the traffic report contains the number of times that listing appeared on the seller's store during the specified date range. For example, LISTING_IMPRESSION_STORE: 157 means the item appeared 157 times in the store during the date range.If you specify dimension=LISTING without specifying any listing_ids in the parameter filter, the traffic report returned in the response contains a maximum of 200 listings., filter: str # This query parameter refines the information returned in the traffic report. Note:  URL encode all the values you supply in the filter parameter. See URL encoding query parameter values as described in URL parameters.Configure the following properties of the filter parameter to tune the traffic report to your needs:  date_range Limits the report to the specified range of dates. This value can be formatted in one of two ways depending on the user's time zone.For America/Los_Angeles time zone, input the date range using YYMMDD format. As this is the default time zone used for timestamps in the report, the time zone does not need to be specified. Enclose the earliest date and end date for the report in brackets (\"[ ]\"), as follows:[YYYYMMDD..YYYYMMDD]For example:[20240101..20240131]For all other time zones, input the date range using ISO 8601 format, and specify the time zone using a UTC offset. A time zone offset is a positive or negative value that represents the number of hours a time zone is from UTC (see UTC Time Zone Converter for offset values for your time zone). Enclose the earliest date and end date for the report in brackets (\"[ ]\"), as follows:[yyyy-MM-dd'T'HH:mm:ss.SSS+|-hh:mm..yyyy-MM-dd'T'HH:mm:ss.SSS+|-hh:mm]For example:[2024-01-01T02:00:00.000-05:00..2024-01-31T02:00:00.000-05:00]Note: All time values entered in this format will be dropped, and will be replaced with 00:00:00.000 for startDate and 23:59:59.000 for endDate in the response body.The maximum range between the start and end dates is 90 days, and the earliest start date you can specify is two years prior to the current date, which is defined as 730 days (365 * 2), not accounting for Leap Year.The last date for which traffic data exists is a value called lastUpdatedDate. eBay returns an error if you specify a date range greater than 90 days, or the start date is after the lastUpdatedDate. If the specified end date is beyond the lastUpdatedDate, eBay returns data up to the lastUpdatedDate.Required: Always listing_ids This filter limits the results to only the supplied list of listingId values. Note: If you specify dimension=LISTING without specifying any listing_ids in this parameter, the traffic report returned in the response contains a maximum of 200 listings.You can specify to 200 different listingId values. Enclose the list of IDs with curly braces (\"{ }\"), and separate multiple values with a pipe character (\"|\").  This filter only returns data for listings that have been either active or sold in last 90 days, and any unsold listings in the last 30 days. All listings must be the seller's and they  must be listed on the marketplace specified by the marketplace_ids filter argument. marketplace_ids This filter limits the report to seller data related to only the specified marketplace ID (currently the filter allows only a single marketplace ID). Enclose the marketplace ID in curly braces (\"{ }\").  Valid values: EBAY_AU EBAY_DEEBAY_ESEBAY_FR EBAY_GB EBAY_ITEBAY_US EBAY_MOTORS_US Required if you set the dimension parameter to DAY. Example filter parameter The following example shows how to configure the filter parameter with the marketplace_ids and date_range filters: filter=marketplace_ids:{EBAY_US},date_range:[20170601..20170828]Encoding this portion of the query parameter sample yields: filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20230601..20230828%5D See samples for additional examples. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/csb:FilterField, metric: str # This query parameter specifies the metrics you want covered in the report. Note:  Unlike names for parameters and enumerated values, metric values are not case sensitive.Valid values:    CLICK_THROUGH_RATE    LISTING_IMPRESSION_SEARCH_RESULTS_PAGE     LISTING_IMPRESSION_STORE    LISTING_IMPRESSION_TOTAL    LISTING_VIEWS_SOURCE_DIRECT    LISTING_VIEWS_SOURCE_OFF_EBAY    LISTING_VIEWS_SOURCE_OTHER_EBAY    LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE    LISTING_VIEWS_SOURCE_STORE    LISTING_VIEWS_TOTAL    SALES_CONVERSION_RATE    TOTAL_IMPRESSION_TOTAL    TRANSACTIONSpecify a comma-separated list of the metrics to include them in the report. See Using different metric parameters for more information including detailed metric descriptions and localized names., sort: str # This query parameter sorts the report on the specified metric.  You can only specify a single metric in the sort parameter and the specified metric must be included in the configuration of the report's metric parameter.  Sorting is helpful when you want to review how a specific metric is performing, such as the CLICK_THROUGH_RATE.  Most reports can be sorted in ascending or descending order. Precede the value of a descending-order request with a minus sign (\"-\"), for example: sort=-CLICK_THROUGH_RATE.Note: There are a couple of constraints on sorting the report by different metrics:Sorting on the SALES_CONVERSION_RATE metric is not supportedThe TRANSACTION metric can only be sorted in the descending order (sorting in the ascending order is not supported).  For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/csb:SortField}\n@returns(200) {dimensionMetadata: [map], endDate: str, header: map{dimensionKeys: [map], metrics: [map]}, lastUpdatedDate: str, records: [map], startDate: str, warnings: [map]} # Success\n@errors {400: Bad Request, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}}