Competitor Price

competitor_price API resource for tracking competitor pricing data per product-region combination over time in Supply Chain & Retail Solutions.

Overview

The competitor_price resource tracks competitor pricing data for specific product-region combinations over time. This competitive intelligence enables comparison against your own pricing to inform pricing strategy and competitive positioning decisions. This resource is optional and only needs to be ingested if competitive pricing analysis is required.

→ For business context (purpose, usage notes, how this resource is used in the solution), see Competitor prices dataset in the User Guide.

Resource Endpoint

/api/v2/ingest/object/{prefix}COMPETITOR_PRICE{suffix}

Supported Methods

Method	Return Type	Description
POST	Response	Ingest (create/update) competitor price records via UPSERT operation

Request Headers

Header	Required	Description
Authorization	Yes	Your Personal Access Token (PAT) from platform.peak.ai
Content-Type	Yes	Must be application/json

Properties

Primary Keys

• product_id (string) - Foreign key reference to products
• region_id (string) - Foreign key reference to regions
• updated_at (datetime) - Timestamp of when the record was last updated

Attributes

About Required + Nullable: every attribute key must appear in each payload (Required: Yes). Nullable: Yes means the value can be null when you don't have data; Nullable: No means a non-null value is required. See Schema definition structure for the underlying rules.

Attribute	Data Type	Required	Nullable	Description
product_id	string	Yes	No	Product identifier (Primary Key, Foreign Key)
region_id	string	Yes	No	Region identifier (Primary Key, Foreign Key)
updated_at	datetime	Yes	Yes	Last update timestamp (Primary Key)
competitor_price	float	Yes	Yes	Competitor's price for this product in this region

Relationships

Outbound References

None

Inbound References

• product - Foreign key product_id references product
• region - Foreign key region_id references region

JSON Representation

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "product_id": "PROD-001",
      "region_id": "EMEA-UK",
      "updated_at": "2025-01-28T10:00:00Z",
      "competitor_price": 149.99
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/QP_COMPETITOR_PRICE_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "product_id": "PROD-001",
        "region_id": "EMEA-UK",
        "updated_at": "2025-01-28T10:00:00Z",
        "competitor_price": 149.99
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

• Foreign Key Dependencies: Requires valid product_id and region_id to exist in their respective tables
• Pricing Intelligence: Used to compare your pricing against competitor offerings
• Custom Attributes: Custom attributes can be added with POST /api/v2/schema/{objectName}/add-attribute, where {objectName} is this table's fully qualified warehouse name ({prefix}COMPETITOR_PRICE{suffix} — for example, QP_COMPETITOR_PRICE_OOTB), as returned by Describe a solution's schema
• Data Validation: All attributes are validated according to their defined data types

Related Resources

• product - Product master data
• region - Regional definitions
• list_price - Your list pricing for comparison