createDSRSummaryByPeriod

Creates a Detailed Seller Ratings (DSR) summary report based on a date range. The date range is based on either transaction end dates or listing dates.

Related calls:

getDSRSummary - Retrieves a specific type of DSR report which can be filtered by Transaction, Period, Category, or Shipping Details.

createDSRSummaryByPeriod Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

Argument	Type	Occurrence	Meaning
Standard Input Fields [Jump to call-specific fields]
Call-specific Input Fields
dateRange	DateRange	Required	Specifies the time period used for collecting DSR data for purchased items. The time period applies to either the end date of the item transaction or the date the item was listed. Note the following restrictions when specifying a date range: Date ranges cannot be more than 90 days in duration or the call will fail. Date ranges cannot be specified to begin more than 16 months before the current date or the call will fail. When retriiving DSR summary reports for a date range, if there are more than 5,000 transanctions in the time period, only the 5,000 most recent transactions will be processed and a warning will be returned. < /li>
dateRange.dateFrom	dateTime	Required	The starting point of the date range. DSRs will be aggregated for items with the specified date range event (transaction end date or listing date) on or after the dateFrom value and before or on the dateTo value.
dateRange.dateTo	dateTime	Required	The end point of the date range. DSRs will be aggregated for items with the specified date range event (transaction end date or listing date) on or after the dateFrom value and before or on the dateTo value.
dateRangeEventType	token	Optional	Type of item event upon which the date range will be based. Date Range Event Types include: TransactionEndDate The specified date range relates to the date transactions were ended. ListingDate The specified date range relates to the date items were listed. Default: TransactionEndDate.

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<createDSRSummaryResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage 
    <error> ErrorData 
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <jobId> string </jobId>
</createDSRSummaryResponse>

Return Value	Type	Occurrence	Meaning
Standard Output Fields [Jump to call-specific fields]
ack	AckValue	Always	Indicates whether there are any errors or warnings associated with the processing of the request. Applicable values: • Failure (out) Errors occurred that prevented the request from being processed successfully. • PartialFailure (out) Reserved for future use. • Success (out) The request was processed successfully without errors or warnings. • Warning (out) The request was processed successfully, but some warnings were returned.
errorMessage	ErrorMessage	Conditionally	Information for an error or warning that occurred when eBay processed the request. Not returned when responseStatus is Success.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Details about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application (out) An error occurred due to a problem with the request, such as missing or invalid fields. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. Once the problem in the application or data is resolved, resend the corrected request to eBay. • Request (out) An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the data is resolved, resend the request to eBay with the corrected data. • System (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain upon which the error occurred. Domains include: Marketplace A business or validation error occurred for the Feedback Service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that resulted in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Applicable values: • Error (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. • Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain upon which the error occurred. Subdomains include: Merchandising The error is specific to the Feedback service. MarketplaceCommon The error is common to all Marketplace services.
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about this time format and converting to and from the GMT time zone.
version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. Developer Technical Support may ask you for the version value when you work with them to troubleshoot issues.
Call-specific Output Fields
jobId	string	Always	A unique identifier associated with the create report request. The jobId is used as input for the getDSRSummary call to retrieve the requested report. Max length: 20.

createDSRSummaryByPeriod Samples

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Creates a DSR summary report for a specific time period.

Description

User magicalbookseller has had a steady increase in sales over time and wants to understand how these changes have been affecting her DSRs. She wants to know how the DSR scores for items sold in December of 2008 compare to items sold the previous month or the same month the previous year. This sample illustrates how to request a DSR summary report for December 2008.

Input

The dateRangeEventType value, TransactionEndDate specifies that the date range is based upon when items sold (i.e., transaction end date). The dateFrom and dateTo fields specify the date range.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="UTF-8"?>
<createDSRSummaryByPeriodRequest xmlns="http://www.ebay.com/marketplace/services">
  <dateRange>
    <dateFrom>2008-12-01T00:00:00.000Z</dateFrom>
    <dateTo>2008-12-31T23:59:59.999Z</dateTo>
  </dateRange>
  <dateRangeEventType>ListingDate</dateRangeEventType>
</createDSRSummaryByPeriodRequest>

Output

The response includes a jobId, which is used with the getSummaryReport call to retrieve the DSR summary report when it is ready. Most reports are ready within an hour of sending the requests to create them.

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<createDSRSummaryResponse xmlns:sct="http://www.ebay.com/soaframework/common/types" xmlns="http://www.ebay.com/marketplace/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2009-02-18T22:45:48.567Z</timestamp>
  <jobId>73657470931103444722</jobId>
</createDSRSummaryResponse>

createDSRSummaryByPeriod Change History

Version	Description
1.0.1 2009-06-24	timestamp (modified): Datatype changed from xs:date to xs:dateTime.
1.0.0 2009-02-04	(added) New call

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Feedback API Call Reference Version 1.0.1

eBay Feedback API
Call Reference Version 1.0.1