Variable vendorTrafficReportConst

Type declaration

• Readonlydefinitions: {
      TrafficAggregate: {
          description: "Describes aggregated traffic metrics for ASINs in the vendor's account.";
          examples: readonly [
              { endDate: "2021-06-12"; glanceViews: 100; startDate: "2021-06-06" },
          ];
          properties: {
              endDate: {
                  description: "The end date of the aggregated data.";
                  examples: readonly ["2021-06-12"];
                  format: "date";
                  type: "string";
              };
              glanceViews: {
                  description: "Customer views of the vendor's product detail pages.";
                  examples: readonly [100];
                  minimum: 0;
                  type: "integer";
              };
              startDate: {
                  description: "The start date of the aggregated data.";
                  examples: readonly ["2021-06-06"];
                  format: "date";
                  type: "string";
              };
          };
          required: readonly ["startDate", "endDate", "glanceViews"];
          type: "object";
      };
      TrafficByAsin: {
          description: "Describes aggregated ASIN-level traffic metrics for ASINs in the vendor's account.";
          examples: readonly [
              {
                  asin: "B123456789";
                  endDate: "2021-06-12";
                  glanceViews: 100;
                  startDate: "2021-06-06";
              },
          ];
          properties: {
              asin: {
                  description: "The Amazon Standard Identification Number.";
                  examples: readonly ["B123456789"];
                  type: "string";
              };
              endDate: {
                  description: "The end date of the aggregated ASIN-level data.";
                  examples: readonly ["2021-06-12"];
                  type: "string";
              };
              glanceViews: {
                  description: "The number of customer views of the product detail page.";
                  examples: readonly [100];
                  minimum: 0;
                  type: "integer";
              };
              startDate: {
                  description: "The start date of the aggregated ASIN-level data.";
                  examples: readonly ["2021-06-06"];
                  type: "string";
              };
          };
          required: readonly ["startDate", "endDate", "asin", "glanceViews"];
          type: "object";
      };
  }

• Readonlydescription: "This report shares data on the customer traffic to the detail pages of the vendor's items both at an aggregated level (across the vendor's entire catalog of items) and at a per-ASIN level. Data is available for different date range aggregation levels: DAY, WEEK, MONTH, QUARTER, YEAR. Requests can span multiple date range periods."

• Readonlyexamples: readonly [
      {
          reportSpecification: {
              dataEndTime: "2021-06-19";
              dataStartTime: "2021-06-06";
              lastUpdatedDate: "2021-06-20";
              marketplaceIds: readonly ["ATVPDKIKX0DER"];
              reportOptions: { reportPeriod: "WEEK" };
              reportType: "GET_VENDOR_TRAFFIC_REPORT";
          };
          trafficAggregate: readonly [
              { endDate: "2021-06-12"; glanceViews: 100; startDate: "2021-06-06" },
              { endDate: "2021-06-19"; glanceViews: 250; startDate: "2021-06-13" },
          ];
          trafficByAsin: readonly [
              {
                  asin: "B123456789";
                  endDate: "2021-06-12";
                  glanceViews: 100;
                  startDate: "2021-06-06";
              },
              {
                  asin: "B123456789";
                  endDate: "2021-06-19";
                  glanceViews: 250;
                  startDate: "2021-06-13";
              },
          ];
      },
  ]

• Readonlyproperties: {
      reportSpecification: {
          description: "The report summary including the specified reporting date range and the last updated date in the input.";
          examples: readonly [
              {
                  dataEndTime: "2021-06-19";
                  dataStartTime: "2021-06-06";
                  lastUpdatedDate: "2021-06-20";
                  marketplaceIds: readonly ["ATVPDKIKX0DER"];
                  reportOptions: { reportPeriod: "WEEK" };
                  reportType: "GET_VENDOR_TRAFFIC_REPORT";
              },
          ];
          properties: {
              dataEndTime: {
                  description: "Determines the end date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the last day in the specified reportPeriod or else a fatal error is returned. For example, dataEndTime must be a Saturday for the WEEK reportPeriod.";
                  examples: readonly ["2021-06-19"];
                  format: "date";
                  type: "string";
              };
              dataStartTime: {
                  description: "Determines the start date of the report - the time component is ignored. For WEEK, MONTH, QUARTER, and YEAR reportPeriods, this value must correspond to the first day in the specified reportPeriod or else a fatal error is returned. For example, dataStartTime must be a Sunday for the WEEK reportPeriod.";
                  examples: readonly ["2021-06-06"];
                  format: "date";
                  type: "string";
              };
              lastUpdatedDate: {
                  description: "The date when the report was last updated. Follows the <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date format of YYYY-MM-DD.";
                  examples: readonly ["2021-06-20"];
                  format: "date";
                  type: "string";
              };
              marketplaceIds: {
                  description: "This parameter must match the marketplaceId of the selling partner account (each selling partner account belongs to one and only one marketplaceId).";
                  examples: readonly [readonly ["ATVPDKIKX0DER"]];
                  items: { type: "string" };
                  type: "array";
              };
              reportOptions: {
                  description: "Report options specifying parameters such as reportPeriod.";
                  examples: readonly [{ reportPeriod: "WEEK" }];
                  properties: {
                      reportPeriod: {
                          description: "The granularity of the data in the report. Valid values are: DAY, WEEK, MONTH, QUARTER, YEAR.";
                          enum: readonly ["DAY", "WEEK", "MONTH", "QUARTER", "YEAR"];
                          type: "string";
                      };
                  };
                  required: readonly ["reportPeriod"];
                  type: "object";
              };
              reportType: {
                  description: "The type of report.";
                  enum: readonly ["GET_VENDOR_TRAFFIC_REPORT"];
                  type: "string";
              };
          };
          required: readonly [
              "reportType",
              "reportOptions",
              "lastUpdatedDate",
              "dataStartTime",
              "dataEndTime",
              "marketplaceIds",
          ];
          type: "object";
      };
      trafficAggregate: {
          items: { $ref: "#/definitions/TrafficAggregate" };
          type: "array";
      };
      trafficByAsin: {
          items: { $ref: "#/definitions/TrafficByAsin" };
          type: "array";
      };
  }

• Readonlyrequired: readonly ["reportSpecification", "trafficAggregate", "trafficByAsin"]

• Readonlytype: "object"