https://github.com/michabbb/sdk-ebay-rest-analytics
A simple SDK for Ebay Sellers Analytics API generated with openapi-generator
https://github.com/michabbb/sdk-ebay-rest-analytics
analytics api ebay php rest sdk seller
Last synced: 3 months ago
JSON representation
A simple SDK for Ebay Sellers Analytics API generated with openapi-generator
- Host: GitHub
- URL: https://github.com/michabbb/sdk-ebay-rest-analytics
- Owner: michabbb
- Created: 2020-06-08T15:17:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-02T10:55:56.000Z (over 4 years ago)
- Last Synced: 2025-01-04T18:27:23.254Z (5 months ago)
- Topics: analytics, api, ebay, php, rest, sdk, seller
- Language: PHP
- Homepage: https://developer.ebay.com/api-docs/sell/analytics/overview.html
- Size: 96.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sdk-ebay-rest-analytics
The Analytics API provides data and information about a seller and their eBay business.
The resources and methods in this API let sellers review information on their listing performance, metrics on their customer service performance, and details on their eBay seller performance rating.
The three resources in the Analytics API provide the following data and information:
-
Customer Service Metric – Returns data on a seller's customer service performance as compared to other seller's in the same peer group. -
Traffic Report – Returns data that shows how buyers are engaging with a seller's listings. -
Seller Standards Profile – Returns data pertaining to a seller's performance rating.
For details on using this API, see Analyzing seller performance.
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.2.0
- Package version: 2.3.2
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
## Requirements
PHP 5.5 and later
## Installation & Usage
### Composer
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/macropage/sdk-ebay-rest-analytics.git"
}
],
"require": {
"macropage/sdk-ebay-rest-analytics": "*@dev"
}
}
```
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
```php
require_once('/path/to/sdk-ebay-rest-analytics/vendor/autoload.php');
```
## Tests
To run the unit tests:
```bash
composer install
./vendor/bin/phpunit
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```php
setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new macropage\SDKs\ebay\rest\analytics\Api\CustomerServiceMetricApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$customerServiceMetricType = 'customerServiceMetricType_example'; // string | 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_DESCRIBED ITEM_NOT_RECEIVED
$evaluationMarketplaceId = 'evaluationMarketplaceId_example'; // string | 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/devzone/rest/api-ref/analytics/types/MarketplaceIdEnum.html
$evaluationType = 'evaluationType_example'; // string | Use this path parameter to specify the type of the seller evaluation you want returned, either: CURRENT – A monthly evaluation that occurs on the 20th of every month. PROJECTED – A daily evaluation that provides a projection of how the seller is currently performing with regards to the upcoming evaluation period.
try {
$result = $apiInstance->getCustomerServiceMetric($customerServiceMetricType, $evaluationMarketplaceId, $evaluationType);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CustomerServiceMetricApi->getCustomerServiceMetric: ', $e->getMessage(), PHP_EOL;
}
?>
```
## Documentation for API Endpoints
All URIs are relative to *https://api.ebay.com/sell/analytics/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CustomerServiceMetricApi* | [**getCustomerServiceMetric**](docs/Api/CustomerServiceMetricApi.md#getcustomerservicemetric) | **GET** /customer_service_metric/{customer_service_metric_type}/{evaluation_type} |
*SellerStandardsProfileApi* | [**findSellerStandardsProfiles**](docs/Api/SellerStandardsProfileApi.md#findsellerstandardsprofiles) | **GET** /seller_standards_profile |
*SellerStandardsProfileApi* | [**getSellerStandardsProfile**](docs/Api/SellerStandardsProfileApi.md#getsellerstandardsprofile) | **GET** /seller_standards_profile/{program}/{cycle} |
*TrafficReportApi* | [**getTrafficReport**](docs/Api/TrafficReportApi.md#gettrafficreport) | **GET** /traffic_report |
## Documentation For Models
- [BenchmarkMetadata](docs/Model/BenchmarkMetadata.md)
- [Cycle](docs/Model/Cycle.md)
- [Definition](docs/Model/Definition.md)
- [Dimension](docs/Model/Dimension.md)
- [DimensionMetric](docs/Model/DimensionMetric.md)
- [Distribution](docs/Model/Distribution.md)
- [Error](docs/Model/Error.md)
- [ErrorParameter](docs/Model/ErrorParameter.md)
- [EvaluationCycle](docs/Model/EvaluationCycle.md)
- [FindSellerStandardsProfilesResponse](docs/Model/FindSellerStandardsProfilesResponse.md)
- [GetCustomerServiceMetricResponse](docs/Model/GetCustomerServiceMetricResponse.md)
- [Header](docs/Model/Header.md)
- [Metadata](docs/Model/Metadata.md)
- [MetadataHeader](docs/Model/MetadataHeader.md)
- [MetadataRecord](docs/Model/MetadataRecord.md)
- [Metric](docs/Model/Metric.md)
- [MetricBenchmark](docs/Model/MetricBenchmark.md)
- [MetricDistribution](docs/Model/MetricDistribution.md)
- [Record](docs/Model/Record.md)
- [Report](docs/Model/Report.md)
- [StandardsProfile](docs/Model/StandardsProfile.md)
- [Value](docs/Model/Value.md)
## Documentation For Authorization
## api_auth
- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://auth.ebay.com/oauth2/authorize
- **Scopes**:
- **https://api.ebay.com/oauth/api_scope/sell.analytics.readonly**: View your selling analytics data, such as performance reports
## Author