Integrate with CompetitionLabs products. Products can also be thought of as an event group, for which a sequence of events can be submitted to CompetitionLabs for processing.
What can you do?
Available Resources
- Find a product by various parameters;
- Retrieve a list of all products which you have created;
- Edit a product;
- Create one product at a time;
- Delete a product;
- Preview a sample product.
Domain Object
Product
Parameter | Type | Description | Request | Response | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
name | String | The name of the product, for example tennis or golf | Yes | Yes | Yes | Yes | Yes | |||||
productType | String | The categorisation of this product by its super type, for example hockey | Yes | Yes | Yes | Yes | Yes | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
description | String | The description of the product for your reference | Optional | Optional | Yes | Yes | Yes | |||||
adjustmentFactor | Double | The multiplier to apply to source values received for this product events | Yes | Yes | Yes | Yes | Yes | |||||
productRefId | String | The reference to this product in your system | Yes | Yes | Yes | Yes | Yes | |||||
actionAdjustmentFactors | Array [Object] | A list of Action Adjustment Factor | Optional | Optional | Yes | Yes | Yes | |||||
productGroups | Array [String] | A list of Strings used to tag products with taxonomy terms. | Optional | Optional | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of MetaData | Optional | Optional | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when a Product was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of a Product | Yes | Yes | Yes |