getBoothStats
Retrieves per-day statistics for the authorized user's booth.
getBoothStats Input
| Argument | Type | Occurrence | Meaning |
|---|---|---|---|
| Call-specific Input Fields | |||
| days | integer | Optional | Number of trailing days to retrieve stats for. Maximum of 60 days allowed. |
| human | boolean | Optional | If true, item view counts in output will not include bots or the seller's views. |
getBoothStats Output
The name for the output returned from this request is getBoothStatsResponse. So, after parsing the serialized response into JSON, you can access the data with something like:
my_json_hash['getBoothStatsResponse']
Here are all the possible output parameters:
| Argument | Type | Occurrence | Meaning |
|---|---|---|---|
| Standard Output Fields | |||
| errorMessage | Container | Conditionally | Description of an error or warning that occurred when Bonanza processed the request. Not returned if the ack value is Success. |
| errorMessage.error | Container |
Conditionally, repeatable: [0..*] |
|
| errorMessage.error.category | ErrorCategory | Conditionally | Currently unused. |
| errorMessage.error.message | string | Conditionally | A description of the error |
| errorMessage.error.type | ErrorType | Conditionally | A unique descriptive name for the error. |
| timestamp | dateTime | Always | This value represents the date and time when Bonanza 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. |
| warnings | Container | Conditionally | Description of a warning that occurred when Bonanza processed the request. |
| warnings.unrecognized_parameters | Container |
Conditionally, repeatable: [0..*] |
An array of unrecognized parameters. |
| Call-specific Output Fields | |||
| itemViews | Array | Always | Total item views, grouped by the day that the view occurred. |
| itemViews[n][0] | date | Always | The day that the item view count applies to. |
| itemViews[n][1] | integer | Always | The total number of item views received on the specified day. |
| boothViews | Array | Always | Total booth views, grouped by the day that the view occurred. |
| boothViews[n][0] | date | Always | The day that the booth view count applies to. |
| boothViews[n][1] | integer | Always | The total number of booth views received on the specified day. |
| soldOffers | Array | Always | Total offers sold, grouped by the day that offer was sold on. |
| soldOffers[n][0] | date | Always | The day that the sold offer count applies to. |
| soldOffers[n][1] | integer | Always | The total number of offers sold on the specified day. |
| revenue | Array | Always | Total revenue for offers sold, grouped by the day that offer was sold on. |
| revenue[n][0] | date | Always | The day that the sold offer revenue applies to. |
| revenue[n][1] | integer | Always | The total revenue from all offers sold on the specified day. |
| days | integer | Always | The number of days of stats included. |
