storesanalyticsreport

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 22, 2023 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package storesanalyticsreport provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.15.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewGetAsinEngagementForStoreRequestWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBody 

func NewGetAsinEngagementForStoreRequestWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBody(server string, brandEntityId string, body GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody) (*http.Request, error)

NewGetAsinEngagementForStoreRequestWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBody calls the generic GetAsinEngagementForStore builder with application/vnd.GetAsinEngagementForStoreRequest.v1+json body

func NewGetAsinEngagementForStoreRequestWithBody 

func NewGetAsinEngagementForStoreRequestWithBody(server string, brandEntityId string, contentType string, body io.Reader) (*http.Request, error)

NewGetAsinEngagementForStoreRequestWithBody generates requests for GetAsinEngagementForStore with any type of body

func NewGetInsightsForStoreAPIRequestWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBody 

func NewGetInsightsForStoreAPIRequestWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBody(server string, brandEntityId string, body GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody) (*http.Request, error)

NewGetInsightsForStoreAPIRequestWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBody calls the generic GetInsightsForStoreAPI builder with application/vnd.GetInsightsForStoreRequest.v1+json body

func NewGetInsightsForStoreAPIRequestWithBody 

func NewGetInsightsForStoreAPIRequestWithBody(server string, brandEntityId string, contentType string, body io.Reader) (*http.Request, error)

NewGetInsightsForStoreAPIRequestWithBody generates requests for GetInsightsForStoreAPI with any type of body

Types

type AsinEngagementDetail 

type AsinEngagementDetail map[string]AsinEngagementDetail_AdditionalProperties

AsinEngagementDetail A key-value pair map which contains the dimension and metric information. The key is either dimension name or metric name, while the value is the corresponding dimension value or metric value.

type AsinEngagementDetail0 

type AsinEngagementDetail0 = string

AsinEngagementDetail0 defines model for .

type AsinEngagementDetail1 

type AsinEngagementDetail1 = int

AsinEngagementDetail1 defines model for .

type AsinEngagementDetail2 

type AsinEngagementDetail2 = float32

AsinEngagementDetail2 defines model for .

type AsinEngagementDetail_AdditionalProperties 

type AsinEngagementDetail_AdditionalProperties struct {
	// contains filtered or unexported fields
}

AsinEngagementDetail_AdditionalProperties defines model for AsinEngagementDetail.AdditionalProperties.

func (AsinEngagementDetail_AdditionalProperties) AsAsinEngagementDetail0 

func (t AsinEngagementDetail_AdditionalProperties) AsAsinEngagementDetail0() (AsinEngagementDetail0, error)

AsAsinEngagementDetail0 returns the union data inside the AsinEngagementDetail_AdditionalProperties as a AsinEngagementDetail0

func (AsinEngagementDetail_AdditionalProperties) AsAsinEngagementDetail1 

func (t AsinEngagementDetail_AdditionalProperties) AsAsinEngagementDetail1() (AsinEngagementDetail1, error)

AsAsinEngagementDetail1 returns the union data inside the AsinEngagementDetail_AdditionalProperties as a AsinEngagementDetail1

func (AsinEngagementDetail_AdditionalProperties) AsAsinEngagementDetail2 

func (t AsinEngagementDetail_AdditionalProperties) AsAsinEngagementDetail2() (AsinEngagementDetail2, error)

AsAsinEngagementDetail2 returns the union data inside the AsinEngagementDetail_AdditionalProperties as a AsinEngagementDetail2

func (*AsinEngagementDetail_AdditionalProperties) FromAsinEngagementDetail0 

func (t *AsinEngagementDetail_AdditionalProperties) FromAsinEngagementDetail0(v AsinEngagementDetail0) error

FromAsinEngagementDetail0 overwrites any union data inside the AsinEngagementDetail_AdditionalProperties as the provided AsinEngagementDetail0

func (*AsinEngagementDetail_AdditionalProperties) FromAsinEngagementDetail1 

func (t *AsinEngagementDetail_AdditionalProperties) FromAsinEngagementDetail1(v AsinEngagementDetail1) error

FromAsinEngagementDetail1 overwrites any union data inside the AsinEngagementDetail_AdditionalProperties as the provided AsinEngagementDetail1

func (*AsinEngagementDetail_AdditionalProperties) FromAsinEngagementDetail2 

func (t *AsinEngagementDetail_AdditionalProperties) FromAsinEngagementDetail2(v AsinEngagementDetail2) error

FromAsinEngagementDetail2 overwrites any union data inside the AsinEngagementDetail_AdditionalProperties as the provided AsinEngagementDetail2

func (AsinEngagementDetail_AdditionalProperties) MarshalJSON 

func (t AsinEngagementDetail_AdditionalProperties) MarshalJSON() ([]byte, error)

func (*AsinEngagementDetail_AdditionalProperties) MergeAsinEngagementDetail0 

func (t *AsinEngagementDetail_AdditionalProperties) MergeAsinEngagementDetail0(v AsinEngagementDetail0) error

MergeAsinEngagementDetail0 performs a merge with any union data inside the AsinEngagementDetail_AdditionalProperties, using the provided AsinEngagementDetail0

func (*AsinEngagementDetail_AdditionalProperties) MergeAsinEngagementDetail1 

func (t *AsinEngagementDetail_AdditionalProperties) MergeAsinEngagementDetail1(v AsinEngagementDetail1) error

MergeAsinEngagementDetail1 performs a merge with any union data inside the AsinEngagementDetail_AdditionalProperties, using the provided AsinEngagementDetail1

func (*AsinEngagementDetail_AdditionalProperties) MergeAsinEngagementDetail2 

func (t *AsinEngagementDetail_AdditionalProperties) MergeAsinEngagementDetail2(v AsinEngagementDetail2) error

MergeAsinEngagementDetail2 performs a merge with any union data inside the AsinEngagementDetail_AdditionalProperties, using the provided AsinEngagementDetail2

func (*AsinEngagementDetail_AdditionalProperties) UnmarshalJSON 

func (t *AsinEngagementDetail_AdditionalProperties) UnmarshalJSON(b []byte) error

type AsinEngagementDimension 

type AsinEngagementDimension string

AsinEngagementDimension User can use dimensions to aggregate the engagement metrics. Supported dimension types:

  • `ASIN` - Amazon Standard Identification Number.

    When *dimension* is omitted, user can retrieve select metrics aggregated at the store level. See *metrics* for details. 

const (
	ASIN AsinEngagementDimension = "ASIN"
)

Defines values for AsinEngagementDimension.

type AsinEngagementMetric 

type AsinEngagementMetric string

AsinEngagementMetric Store Metric Types: Metrics aggregated at the store level. To be used with *dimension* omitted, otherwise a 422 response is returned.

  • `TOTAL_VIEWS` - Total number of times customers viewed ASINs on the store’s pages. A view can happen once per store page visit.

  • `TOTAL_CLICKS` - Total count of times a customer clicked an ASIN related widget on the store’s pages.

    Asin Metric Types: Metrics aggregated at the ASIN level. To be used with a supported dimension type (see *dimension*), otherwise a 422 response is returned.

  • `RENDERS` - Number of times the asin rendered on a store page, this does not guarentee the customer saw the asin.

  • `VIEWS` - Number of times the a customer viewed an ASIN. Can happen once per page visit.

  • `ORDERS` - Estimated total orders placed by Store visitors on the day of the ASIN view. Orders can have one or more total units.

  • `UNITS` - Estimated units purchased by Store visitors during attributed orders for the ASIN.

  • `ADD_TO_CARTS` - Total number of times an asin was added to cart by a customer on a store page.

  • `IN_STOCK_VIEWS` - Total views of an asin on a store page while the asin was in stock. For asins with variations, the customer must have selected a variation which as in stock to be counted.

  • `AVERAGE_IN_STOCK_PRICE` - Average price in local currency the asin was viewed at by customers while it was in stock.

  • `IN_STOCK_RATE` - Rate at which customers viewed an asin while it was in stock.

  • `AVERAGE_SALE_PRICE` - Average price in local currency for which the asin sold for during the order.

  • `CONVERSION_RATE` - Rate at which customers ordered a unit of the item over how many times customers clicked the item.

  • `CLICKS` - Count of how many times a customer clicked an asin related widget on the store page.

  • `CLICK_RATE` - Rate at which the asin was clicker per view. This ratio can be above one if the widget is interacted with on a widget with engaging features. (Product Showcase, Variation Selection in Product Grid, or Interactive Image) 

const (
	AsinEngagementMetricADDTOCARTS          AsinEngagementMetric = "ADD_TO_CARTS"
	AsinEngagementMetricAVERAGEINSTOCKPRICE AsinEngagementMetric = "AVERAGE_IN_STOCK_PRICE"
	AsinEngagementMetricAVERAGESALEPRICE    AsinEngagementMetric = "AVERAGE_SALE_PRICE"
	AsinEngagementMetricCLICKRATE           AsinEngagementMetric = "CLICK_RATE"
	AsinEngagementMetricCLICKS              AsinEngagementMetric = "CLICKS"
	AsinEngagementMetricCONVERSIONRATE      AsinEngagementMetric = "CONVERSION_RATE"
	AsinEngagementMetricINSTOCKRATE         AsinEngagementMetric = "IN_STOCK_RATE"
	AsinEngagementMetricINSTOCKVIEWS        AsinEngagementMetric = "IN_STOCK_VIEWS"
	AsinEngagementMetricORDERS              AsinEngagementMetric = "ORDERS"
	AsinEngagementMetricRENDERS             AsinEngagementMetric = "RENDERS"
	AsinEngagementMetricTOTALCLICKS         AsinEngagementMetric = "TOTAL_CLICKS"
	AsinEngagementMetricTOTALVIEWS          AsinEngagementMetric = "TOTAL_VIEWS"
	AsinEngagementMetricUNITS               AsinEngagementMetric = "UNITS"
	AsinEngagementMetricVIEWS               AsinEngagementMetric = "VIEWS"
)

Defines values for AsinEngagementMetric.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn

	// A callback for modifying response which are generated after receive from the network.
	ResponseEditors []ResponseEditorFn

	// The user agent header identifies your application, its version number, and the platform and programming language you are using.
	// You must include a user agent header in each request submitted to the sales partner API.
	UserAgent string
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetAsinEngagementForStoreWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBody 

func (c *Client) GetAsinEngagementForStoreWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBody(ctx context.Context, brandEntityId string, body GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody) (*http.Response, error)

func (*Client) GetAsinEngagementForStoreWithBody 

func (c *Client) GetAsinEngagementForStoreWithBody(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*http.Response, error)

func (*Client) GetInsightsForStoreAPIWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBody 

func (c *Client) GetInsightsForStoreAPIWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBody(ctx context.Context, brandEntityId string, body GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody) (*http.Response, error)

func (*Client) GetInsightsForStoreAPIWithBody 

func (c *Client) GetInsightsForStoreAPIWithBody(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetAsinEngagementForStoreWithBody request with any body
	GetAsinEngagementForStoreWithBody(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*http.Response, error)

	GetAsinEngagementForStoreWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBody(ctx context.Context, brandEntityId string, body GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody) (*http.Response, error)

	// GetInsightsForStoreAPIWithBody request with any body
	GetInsightsForStoreAPIWithBody(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*http.Response, error)

	GetInsightsForStoreAPIWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBody(ctx context.Context, brandEntityId string, body GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithResponseEditorFn added in v0.0.2 

func WithResponseEditorFn(fn ResponseEditorFn) ClientOption

WithResponseEditorFn allows setting up a callback function, which will be called right after receive the response.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetAsinEngagementForStoreWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBodyWithResponse 

func (c *ClientWithResponses) GetAsinEngagementForStoreWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBodyWithResponse(ctx context.Context, brandEntityId string, body GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody) (*GetAsinEngagementForStoreResp, error)

func (*ClientWithResponses) GetAsinEngagementForStoreWithBodyWithResponse 

func (c *ClientWithResponses) GetAsinEngagementForStoreWithBodyWithResponse(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*GetAsinEngagementForStoreResp, error)

GetAsinEngagementForStoreWithBodyWithResponse request with arbitrary body returning *GetAsinEngagementForStoreResp

func (*ClientWithResponses) GetInsightsForStoreAPIWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBodyWithResponse 

func (c *ClientWithResponses) GetInsightsForStoreAPIWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBodyWithResponse(ctx context.Context, brandEntityId string, body GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody) (*GetInsightsForStoreAPIResp, error)

func (*ClientWithResponses) GetInsightsForStoreAPIWithBodyWithResponse 

func (c *ClientWithResponses) GetInsightsForStoreAPIWithBodyWithResponse(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*GetInsightsForStoreAPIResp, error)

GetInsightsForStoreAPIWithBodyWithResponse request with arbitrary body returning *GetInsightsForStoreAPIResp

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetAsinEngagementForStoreWithBodyWithResponse request with any body
	GetAsinEngagementForStoreWithBodyWithResponse(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*GetAsinEngagementForStoreResp, error)

	GetAsinEngagementForStoreWithApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONBodyWithResponse(ctx context.Context, brandEntityId string, body GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody) (*GetAsinEngagementForStoreResp, error)

	// GetInsightsForStoreAPIWithBodyWithResponse request with any body
	GetInsightsForStoreAPIWithBodyWithResponse(ctx context.Context, brandEntityId string, contentType string, body io.Reader) (*GetInsightsForStoreAPIResp, error)

	GetInsightsForStoreAPIWithApplicationVndGetInsightsForStoreRequestV1PlusJSONBodyWithResponse(ctx context.Context, brandEntityId string, body GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody) (*GetInsightsForStoreAPIResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody 

type GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody = GetAsinEngagementForStoreRequest

GetAsinEngagementForStoreApplicationVndGetAsinEngagementForStoreRequestV1PlusJSONRequestBody defines body for GetAsinEngagementForStore for application/vnd.GetAsinEngagementForStoreRequest.v1+json ContentType.

type GetAsinEngagementForStoreRequest 

type GetAsinEngagementForStoreRequest struct {
	// Dimension User can use dimensions to aggregate the engagement metrics. Supported dimension types:
	//   * `ASIN` - Amazon Standard Identification Number.
	//
	//   When *dimension* is omitted, user can retrieve select metrics aggregated at the store level. See *metrics* for details.
	Dimension *AsinEngagementDimension `json:"dimension,omitempty"`

	// EndDate The end date (inclusive) in YYYY-MM-DD format for the time period from when to fetch the insights.
	EndDate openapi_types.Date `json:"endDate"`

	// Metrics List of the engagement metrics to be fetched. At least one metric should be specified.
	Metrics []AsinEngagementMetric `json:"metrics"`

	// OrderBy Describes whether a sort should be ascending (ASC) or descending (DESC).
	OrderBy *SortOrder `json:"orderBy,omitempty"`

	// SortBy Nullable metric to sort on. If a value is provided, it must also appear in the metrics list. If no value is provided, the result is not guaranteed to be sorted. This field is only valid when the dimension is ASIN.
	SortBy *interface{} `json:"sortBy,omitempty"`

	// StartDate The start date (inclusive) in YYYY-MM-DD format for the time period from when to fetch the insights.
	StartDate openapi_types.Date `json:"startDate"`
}

GetAsinEngagementForStoreRequest defines model for GetAsinEngagementForStoreRequest.

type GetAsinEngagementForStoreResp 

type GetAsinEngagementForStoreResp struct {
	Body                                                     []byte
	HTTPResponse                                             *http.Response
	ApplicationvndGetAsinEngagementForStoreResponseV1JSON200 *GetAsinEngagementForStoreResponse
	JSON400                                                  *StoresAnalyticsAPIErrorResponse
	JSON401                                                  *StoresAnalyticsAPIErrorResponse
	JSON403                                                  *StoresAnalyticsAPIErrorResponse
	JSON404                                                  *StoresAnalyticsAPIErrorResponse
	JSON422                                                  *StoresAnalyticsAPIErrorResponse
	JSON429                                                  *StoresAnalyticsAPIErrorResponse
	JSON500                                                  *StoresAnalyticsAPIErrorResponse
}

func ParseGetAsinEngagementForStoreResp 

func ParseGetAsinEngagementForStoreResp(rsp *http.Response) (*GetAsinEngagementForStoreResp, error)

ParseGetAsinEngagementForStoreResp parses an HTTP response from a GetAsinEngagementForStoreWithResponse call

func (GetAsinEngagementForStoreResp) Status 

func (r GetAsinEngagementForStoreResp) Status() string

Status returns HTTPResponse.Status

func (GetAsinEngagementForStoreResp) StatusCode 

func (r GetAsinEngagementForStoreResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetAsinEngagementForStoreResponse 

type GetAsinEngagementForStoreResponse struct {
	// Dimension User can use dimensions to aggregate the engagement metrics. Supported dimension types:
	//   * `ASIN` - Amazon Standard Identification Number.
	//
	//   When *dimension* is omitted, user can retrieve select metrics aggregated at the store level. See *metrics* for details.
	Dimension      *AsinEngagementDimension `json:"dimension,omitempty"`
	MetricsDetails *[]AsinEngagementDetail  `json:"metricsDetails,omitempty"`
}

GetAsinEngagementForStoreResponse defines model for GetAsinEngagementForStoreResponse.

type GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody 

type GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody = GetInsightsForStoreRequest

GetInsightsForStoreAPIApplicationVndGetInsightsForStoreRequestV1PlusJSONRequestBody defines body for GetInsightsForStoreAPI for application/vnd.GetInsightsForStoreRequest.v1+json ContentType.

type GetInsightsForStoreAPIResp 

type GetInsightsForStoreAPIResp struct {
	Body                                               []byte
	HTTPResponse                                       *http.Response
	ApplicationvndGetInsightsForStoreResponseV1JSON200 *GetInsightsForStoreResponse
	JSON400                                            *StoresAnalyticsAPIErrorResponse
	JSON401                                            *StoresAnalyticsAPIErrorResponse
	JSON403                                            *StoresAnalyticsAPIErrorResponse
	JSON404                                            *StoresAnalyticsAPIErrorResponse
	JSON422                                            *StoresAnalyticsAPIErrorResponse
	JSON429                                            *StoresAnalyticsAPIErrorResponse
	JSON500                                            *StoresAnalyticsAPIErrorResponse
}

func ParseGetInsightsForStoreAPIResp 

func ParseGetInsightsForStoreAPIResp(rsp *http.Response) (*GetInsightsForStoreAPIResp, error)

ParseGetInsightsForStoreAPIResp parses an HTTP response from a GetInsightsForStoreAPIWithResponse call

func (GetInsightsForStoreAPIResp) Status 

func (r GetInsightsForStoreAPIResp) Status() string

Status returns HTTPResponse.Status

func (GetInsightsForStoreAPIResp) StatusCode 

func (r GetInsightsForStoreAPIResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInsightsForStoreRequest 

type GetInsightsForStoreRequest struct {
	// Dimension User can use dimensions to aggregate the insight metrics. Supported dimension types:
	//   * `DATE` - Date of the visitor’s visit.
	//   * `PAGE` - The Store page.
	//   * `SOURCE` - The traffic source from which the visitor arrived to the Store.
	//   * `TAG` - The traffic tag from which the visitor arrived to the Store.
	//
	// <br><br> Not all InsightMetrics can be aggregated using above dimensions. Below is the supported metrics for each dimension,
	// <table>
	//   <tr>
	//     <th>InsightDimension</th>
	//     <th>Supported InsightMetrics</th>
	//   </tr>
	//   <tr>
	//     <th>DATE</th>
	//     <th>All the InsightMetrics</th>
	//   </tr>
	//   <tr>
	//     <th>PAGE</th>
	//     <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
	//   </tr>
	//   <tr>
	//     <th>SOURCE</th>
	//     <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
	//   </tr>
	//   <tr>
	//     <th>TAG</th>
	//     <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
	//   </tr>
	// </table>
	// <br><br>
	Dimension InsightDimension `json:"dimension"`

	// EndDate The end date (inclusive) in YYYY-MM-DD format for the time period from when to fetch the insights.
	EndDate openapi_types.Date `json:"endDate"`
	Filter  *InsightFilter     `json:"filter,omitempty"`

	// MaxResult The max number of result that will be returned in one response. The max allowed value will be 1500. If the parameter is not presented, it will be default to 1500.
	MaxResult *int `json:"maxResult,omitempty"`

	// Metrics List of the insight metrics to be fetched. Only one metric should be specified.
	Metrics []InsightMetric `json:"metrics"`

	// PaginationToken The token that last request returned. It will be used to fetch next page of response.
	PaginationToken *string `json:"paginationToken,omitempty"`

	// StartDate The start date (inclusive) in YYYY-MM-DD format for the time period from when to fetch the insights. The earliest date will be 2018-09-01, if the input is earlier, it will be default to 2018-09-01
	StartDate openapi_types.Date `json:"startDate"`
}

GetInsightsForStoreRequest defines model for GetInsightsForStoreRequest.

type GetInsightsForStoreResponse 

type GetInsightsForStoreResponse struct {
	// Dimension User can use dimensions to aggregate the insight metrics. Supported dimension types:
	//   * `DATE` - Date of the visitor’s visit.
	//   * `PAGE` - The Store page.
	//   * `SOURCE` - The traffic source from which the visitor arrived to the Store.
	//   * `TAG` - The traffic tag from which the visitor arrived to the Store.
	//
	// <br><br> Not all InsightMetrics can be aggregated using above dimensions. Below is the supported metrics for each dimension,
	// <table>
	//   <tr>
	//     <th>InsightDimension</th>
	//     <th>Supported InsightMetrics</th>
	//   </tr>
	//   <tr>
	//     <th>DATE</th>
	//     <th>All the InsightMetrics</th>
	//   </tr>
	//   <tr>
	//     <th>PAGE</th>
	//     <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
	//   </tr>
	//   <tr>
	//     <th>SOURCE</th>
	//     <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
	//   </tr>
	//   <tr>
	//     <th>TAG</th>
	//     <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
	//   </tr>
	// </table>
	// <br><br>
	Dimension *InsightDimension `json:"dimension,omitempty"`

	// Filter The filter to restrict the return data. Users can specifiy the pages/source/tags they feel interested in for the insights. The relationship between each field is 'AND'. E.g. The user can speficy {pageIds=[page1_id], sources=[source1]} to retrieve the related insights for page1 and source1. The user can specify {pageIds=[page1_id], tags=[tag1_name]} to retrieve related insights for page1 and tag1. <br><br> However, specifying both "sources" and "tags" is currently not supported. Users cannot retrieve insights for given sources and tags as all the tags belong to a specific source named "tagged".
	Filter         *InsightFilter          `json:"filter,omitempty"`
	MetricsDetails *[]InsightMetricsDetail `json:"metricsDetails,omitempty"`

	// PaginationToken The token can be directly used to fetch next page of the result. The token can only been used when the token is been created less than 24 hours and the request input is same as last request
	PaginationToken *string `json:"paginationToken,omitempty"`
}

GetInsightsForStoreResponse defines model for GetInsightsForStoreResponse.

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InsightDimension 

type InsightDimension string

InsightDimension User can use dimensions to aggregate the insight metrics. Supported dimension types:

  • `DATE` - Date of the visitor’s visit.
  • `PAGE` - The Store page.
  • `SOURCE` - The traffic source from which the visitor arrived to the Store.
  • `TAG` - The traffic tag from which the visitor arrived to the Store.

<br><br> Not all InsightMetrics can be aggregated using above dimensions. Below is the supported metrics for each dimension, <table> 

<tr>
  <th>InsightDimension</th>
  <th>Supported InsightMetrics</th>
</tr>
<tr>
  <th>DATE</th>
  <th>All the InsightMetrics</th>
</tr>
<tr>
  <th>PAGE</th>
  <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
</tr>
<tr>
  <th>SOURCE</th>
  <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
</tr>
<tr>
  <th>TAG</th>
  <th>VIEWS, ORDERS, UNITS, SALES, VISITS</th>
</tr>

</table> <br><br> 

const (
	DATE   InsightDimension = "DATE"
	PAGE   InsightDimension = "PAGE"
	SOURCE InsightDimension = "SOURCE"
	TAG    InsightDimension = "TAG"
)

Defines values for InsightDimension.

type InsightFilter 

type InsightFilter struct {
	// PageIds List of pages to be fetched for insight metrics. Users can first make request to the API with the same parameters but without the filter to retrieve all the available page ids.
	PageIds *[]string `json:"pageIds,omitempty"`

	// Sources List of sources to be fetched for insight metrics.
	Sources *[]TrafficSource `json:"sources,omitempty"`

	// Tags List of tags to be fetched for insight metrics. Users can first make request to the API with the same parameters but without the filter to retrieve all the available tag names.
	Tags *[]string `json:"tags,omitempty"`
}

InsightFilter The filter to restrict the return data. Users can specifiy the pages/source/tags they feel interested in for the insights. The relationship between each field is 'AND'. E.g. The user can speficy {pageIds=[page1_id], sources=[source1]} to retrieve the related insights for page1 and source1. The user can specify {pageIds=[page1_id], tags=[tag1_name]} to retrieve related insights for page1 and tag1. <br><br> However, specifying both "sources" and "tags" is currently not supported. Users cannot retrieve insights for given sources and tags as all the tags belong to a specific source named "tagged".

type InsightMetric 

type InsightMetric string

InsightMetric Insight Metric Type:

  • `VIEWS` - Number of page views. Data is available from August 30, 2017. <br> "VIEW" metric can be aggregated by all InsightDimensions.
  • `ORDERS` - Estimated total orders placed by Store visitors within 14 days of their visit. Orders contain one or more units sold. Data is available from April 15, 2018. <br> "ORDERS" metric can be aggregated by all the InsightDimensions.
  • `UNITS` - Estimated units purchased by Store visitors within 14 days of their last visit. Data is available from December 25, 2017. <br> "UNITS" metric can be aggregated by all the InsightDimensions.
  • `SALES` - Estimated total sales generated by Store visitors within 14 days of their last visit. Data is available from December 25, 2017. <br> "SALES" metric can be aggregated by all the InsightDimensions.
  • `VISITS` - Total visits to a page or from a traffic source within a single day. Each visitor can visit more than one page, and they can visit your Store from more than one traffic source. Data is available from May 30, 2018. <br> "VISITS" metric can be aggregated by all the InsightDimensions.
  • `VISITORS` - Total visitors to your Store within the selected date range, calculated based on daily unique users or devices. One visitor can visit more than one page, and they can visit your Store from more than one traffic source. The total visitors by page or source may sum up to a value larger than the total visitors by day to the Store or to the page. Data is available from August 30, 2017. <br> "VISITORS" metric currently can only be aggregated by InsightDimention "Date". Users won't be able to get this metric when specifying other InsightDimensions. This is because number of visitors are measured at store level. This also means this metric won't be impacted by the InsightFilter. <br> "SCORE_LEVEL" This metric is for Store Quality rating calculated on various factors by SEAS. It can be `HIGH`, `MEDIUM` or `LOW`. <br> "PERCENTILE_IN_PEERSET" This metric is to show the percentile in similar(peer) stores. This is in Beta mode and will only be available for Insights Dashboard client. <br> "RECOMMENDATIONS" This metric is an Array of Object containing two fields. First field, `recommendedAction` is a description of recommendation (for example `Add a video`) and second field, `actionWeight`, is the improvement it would bring in the overall store quality score This is in Beta mode and will only be available for Insights Dashboard client. <br> "CONTRIBUTORS" This metric is the array of recommendations applied by the Store Owner which resulted in the improvement of overall store quality score. This is in Beta mode and will only be available for Insights Dashboard client. <br> "DWELL" This metric is the time a customer spends on the store, on an average. This is in Beta mode and will only be available for Insights Dashboard client. <br> "PEER_DWELL" This metric is the time a customer spends on the other similar (peer) stores the store, on an average.This is in Beta mode and will only be available for Insights Dashboard client.
const (
	InsightMetricCONTRIBUTORS        InsightMetric = "CONTRIBUTORS"
	InsightMetricDWELL               InsightMetric = "DWELL"
	InsightMetricORDERS              InsightMetric = "ORDERS"
	InsightMetricPEERDWELL           InsightMetric = "PEER_DWELL"
	InsightMetricPERCENTILEINPEERSET InsightMetric = "PERCENTILE_IN_PEERSET"
	InsightMetricRECOMMENDATIONS     InsightMetric = "RECOMMENDATIONS"
	InsightMetricSALES               InsightMetric = "SALES"
	InsightMetricSCORELEVEL          InsightMetric = "SCORE_LEVEL"
	InsightMetricUNITS               InsightMetric = "UNITS"
	InsightMetricVIEWS               InsightMetric = "VIEWS"
	InsightMetricVISITORS            InsightMetric = "VISITORS"
	InsightMetricVISITS              InsightMetric = "VISITS"
)

Defines values for InsightMetric.

type InsightMetricsDetail 

type InsightMetricsDetail map[string]InsightMetricsDetail_AdditionalProperties

InsightMetricsDetail A key-value pair map which contains the dimension and metric information. The key is either dimension name or metric name, while the value is the corresponding dimension value or metric value. Addition of boolean,Array and Object is solely for the Store Quality Score metrics purpose which are in BETA phase currently.

type InsightMetricsDetail0 

type InsightMetricsDetail0 = string

InsightMetricsDetail0 defines model for .

type InsightMetricsDetail1 

type InsightMetricsDetail1 = int

InsightMetricsDetail1 defines model for .

type InsightMetricsDetail2 

type InsightMetricsDetail2 = float32

InsightMetricsDetail2 defines model for .

type InsightMetricsDetail3 

type InsightMetricsDetail3 = bool

InsightMetricsDetail3 defines model for .

type InsightMetricsDetail4 

type InsightMetricsDetail4 = []string

InsightMetricsDetail4 List of CONTRIBUTORS to the store quality score.

type InsightMetricsDetail5 

type InsightMetricsDetail5 = []StoreQualityRecommendation

InsightMetricsDetail5 List of RECOMMENDATIONS to the store quality score.

type InsightMetricsDetail_AdditionalProperties 

type InsightMetricsDetail_AdditionalProperties struct {
	// contains filtered or unexported fields
}

InsightMetricsDetail_AdditionalProperties defines model for InsightMetricsDetail.AdditionalProperties.

func (InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail0 

func (t InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail0() (InsightMetricsDetail0, error)

AsInsightMetricsDetail0 returns the union data inside the InsightMetricsDetail_AdditionalProperties as a InsightMetricsDetail0

func (InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail1 

func (t InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail1() (InsightMetricsDetail1, error)

AsInsightMetricsDetail1 returns the union data inside the InsightMetricsDetail_AdditionalProperties as a InsightMetricsDetail1

func (InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail2 

func (t InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail2() (InsightMetricsDetail2, error)

AsInsightMetricsDetail2 returns the union data inside the InsightMetricsDetail_AdditionalProperties as a InsightMetricsDetail2

func (InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail3 

func (t InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail3() (InsightMetricsDetail3, error)

AsInsightMetricsDetail3 returns the union data inside the InsightMetricsDetail_AdditionalProperties as a InsightMetricsDetail3

func (InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail4 

func (t InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail4() (InsightMetricsDetail4, error)

AsInsightMetricsDetail4 returns the union data inside the InsightMetricsDetail_AdditionalProperties as a InsightMetricsDetail4

func (InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail5 

func (t InsightMetricsDetail_AdditionalProperties) AsInsightMetricsDetail5() (InsightMetricsDetail5, error)

AsInsightMetricsDetail5 returns the union data inside the InsightMetricsDetail_AdditionalProperties as a InsightMetricsDetail5

func (*InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail0 

func (t *InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail0(v InsightMetricsDetail0) error

FromInsightMetricsDetail0 overwrites any union data inside the InsightMetricsDetail_AdditionalProperties as the provided InsightMetricsDetail0

func (*InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail1 

func (t *InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail1(v InsightMetricsDetail1) error

FromInsightMetricsDetail1 overwrites any union data inside the InsightMetricsDetail_AdditionalProperties as the provided InsightMetricsDetail1

func (*InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail2 

func (t *InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail2(v InsightMetricsDetail2) error

FromInsightMetricsDetail2 overwrites any union data inside the InsightMetricsDetail_AdditionalProperties as the provided InsightMetricsDetail2

func (*InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail3 

func (t *InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail3(v InsightMetricsDetail3) error

FromInsightMetricsDetail3 overwrites any union data inside the InsightMetricsDetail_AdditionalProperties as the provided InsightMetricsDetail3

func (*InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail4 

func (t *InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail4(v InsightMetricsDetail4) error

FromInsightMetricsDetail4 overwrites any union data inside the InsightMetricsDetail_AdditionalProperties as the provided InsightMetricsDetail4

func (*InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail5 

func (t *InsightMetricsDetail_AdditionalProperties) FromInsightMetricsDetail5(v InsightMetricsDetail5) error

FromInsightMetricsDetail5 overwrites any union data inside the InsightMetricsDetail_AdditionalProperties as the provided InsightMetricsDetail5

func (InsightMetricsDetail_AdditionalProperties) MarshalJSON 

func (t InsightMetricsDetail_AdditionalProperties) MarshalJSON() ([]byte, error)

func (*InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail0 

func (t *InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail0(v InsightMetricsDetail0) error

MergeInsightMetricsDetail0 performs a merge with any union data inside the InsightMetricsDetail_AdditionalProperties, using the provided InsightMetricsDetail0

func (*InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail1 

func (t *InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail1(v InsightMetricsDetail1) error

MergeInsightMetricsDetail1 performs a merge with any union data inside the InsightMetricsDetail_AdditionalProperties, using the provided InsightMetricsDetail1

func (*InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail2 

func (t *InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail2(v InsightMetricsDetail2) error

MergeInsightMetricsDetail2 performs a merge with any union data inside the InsightMetricsDetail_AdditionalProperties, using the provided InsightMetricsDetail2

func (*InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail3 

func (t *InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail3(v InsightMetricsDetail3) error

MergeInsightMetricsDetail3 performs a merge with any union data inside the InsightMetricsDetail_AdditionalProperties, using the provided InsightMetricsDetail3

func (*InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail4 

func (t *InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail4(v InsightMetricsDetail4) error

MergeInsightMetricsDetail4 performs a merge with any union data inside the InsightMetricsDetail_AdditionalProperties, using the provided InsightMetricsDetail4

func (*InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail5 

func (t *InsightMetricsDetail_AdditionalProperties) MergeInsightMetricsDetail5(v InsightMetricsDetail5) error

MergeInsightMetricsDetail5 performs a merge with any union data inside the InsightMetricsDetail_AdditionalProperties, using the provided InsightMetricsDetail5

func (*InsightMetricsDetail_AdditionalProperties) UnmarshalJSON 

func (t *InsightMetricsDetail_AdditionalProperties) UnmarshalJSON(b []byte) error

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseEditorFn added in v0.0.2 

type ResponseEditorFn func(ctx context.Context, rsp *http.Response) error

ResponseEditorFn is the function signature for the ResponseEditor callback function

type SortOrder 

type SortOrder string

SortOrder Describes whether a sort should be ascending (ASC) or descending (DESC). 

const (
	ASC  SortOrder = "ASC"
	DESC SortOrder = "DESC"
)

Defines values for SortOrder.

type StoreQualityRecommendation 

type StoreQualityRecommendation struct {
	// ActionWeight The weight by which store quality could improve by this recommendations.
	ActionWeight *float32 `json:"actionWeight,omitempty"`

	// RecommendedAction description of the recommendation.
	RecommendedAction *string `json:"recommendedAction,omitempty"`
}

StoreQualityRecommendation The Object containing recommendations to improve store quality score.

type StoresAnalyticsAPIErrorResponse 

type StoresAnalyticsAPIErrorResponse struct {
	// Code The HTTP status code of the response.
	Code *string `json:"code,omitempty"`

	// Details A human-readable description of the response.
	Details *string `json:"details,omitempty"`
}

StoresAnalyticsAPIErrorResponse The error response object for analytics API.

type TrafficSource 

type TrafficSource string

TrafficSource Traffic Source Type:

  • `ADS` - Traffic from Sponsored Brands ads on Amazon.
  • `ORGANIC` - Traffic originating from your brand link on Amazon product detail pages.
  • `OTHER` - All other traffic sources not categorized.
const (
	ADS     TrafficSource = "ADS"
	ORGANIC TrafficSource = "ORGANIC"
	OTHER   TrafficSource = "OTHER"
)

Defines values for TrafficSource.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.