Description:
Returns a list of sample products.
Resource URL:
https://<apphost>.competitionlabs.com/api/<your-space-name>/products/sample
Request headers
| Key | Value | Required |
|---|---|---|
X-API-KEY | Your unique API key | Yes |
Content-Type | application/json | Yes |
Request URL parameters
Parameter | Type | Required | Description |
|---|---|---|---|
space | String | Yes | This is the space name which is linked to the account |
EXAMPLE
Request Expand source
curl --header "X-API-KEY: <your-api-key>" --request GET https://app.competitionlabs.com/api/<your-space-name>/products/sample
Response Expand source
{
"data": [
{
"jsonClass": "Product",
"name": "Pokeable",
"productType": "Cards",
"accountId": "j-PsRm0BBZeE7Tj3JvHi",
"description": "1st product created.",
"adjustmentFactor": 4.12,
"productRefId": "ex-product-ref-sample-id-2",
"actionAdjustmentFactors": [
{
"ruleActionHelper": {
"jsonClass": "RuleActionHelper",
"name": "Daily Login",
"key": "daily-login",
"description": "daily login bonus",
"accountId": "j-PsRm0BBZeE7Tj3JvHi",
"system": true,
"unitOfMeasureType": "Time",
"metadata": [
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v1"
},
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v2"
},
{
"jsonClass": "Metadata",
"key": "k2",
"value": "k2v1"
}
],
"created": "2019-09-19T00:29:04.703+0000",
"id": "kuPsRm0BBZeE7Tj3J_E_"
},
"adjustmentFactor": 1.0
}
],
"productGroups": [
"Slot games"
],
"metadata": [
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v1"
},
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v2"
},
{
"jsonClass": "Metadata",
"key": "k2",
"value": "k2v1"
}
],
"created": "2019-09-19T00:29:04.703+0000",
"id": "k-PsRm0BBZeE7Tj3J_E_"
},
{
"jsonClass": "Product",
"name": "Pokeable",
"productType": "Cards",
"accountId": "j-PsRm0BBZeE7Tj3JvHi",
"description": "1st product created.",
"adjustmentFactor": 4.12,
"productRefId": "ex-product-ref-sample-id-2",
"actionAdjustmentFactors": [
{
"ruleActionHelper": {
"jsonClass": "RuleActionHelper",
"name": "Daily Login",
"key": "daily-login",
"description": "daily login bonus",
"accountId": "j-PsRm0BBZeE7Tj3JvHi",
"system": true,
"unitOfMeasureType": "Time",
"metadata": [
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v1"
},
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v2"
},
{
"jsonClass": "Metadata",
"key": "k2",
"value": "k2v1"
}
],
"created": "2019-09-19T00:29:04.703+0000",
"id": "kuPsRm0BBZeE7Tj3J_E_"
},
"adjustmentFactor": 1.0
}
],
"productGroups": [
"Slot games"
],
"metadata": [
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v1"
},
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v2"
},
{
"jsonClass": "Metadata",
"key": "k2",
"value": "k2v1"
}
],
"created": "2019-09-19T00:29:04.703+0000",
"id": "k-PsRm0BBZeE7Tj3J_E_"
},
{
"jsonClass": "Product",
"name": "Pokeable",
"productType": "Cards",
"accountId": "j-PsRm0BBZeE7Tj3JvHi",
"description": "1st product created.",
"adjustmentFactor": 4.12,
"productRefId": "ex-product-ref-sample-id-2",
"actionAdjustmentFactors": [
{
"ruleActionHelper": {
"jsonClass": "RuleActionHelper",
"name": "Daily Login",
"key": "daily-login",
"description": "daily login bonus",
"accountId": "j-PsRm0BBZeE7Tj3JvHi",
"system": true,
"unitOfMeasureType": "Time",
"metadata": [
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v1"
},
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v2"
},
{
"jsonClass": "Metadata",
"key": "k2",
"value": "k2v1"
}
],
"created": "2019-09-19T00:29:04.703+0000",
"id": "kuPsRm0BBZeE7Tj3J_E_"
},
"adjustmentFactor": 1.0
}
],
"productGroups": [
"Slot games"
],
"metadata": [
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v1"
},
{
"jsonClass": "Metadata",
"key": "k1",
"value": "k1v2"
},
{
"jsonClass": "Metadata",
"key": "k2",
"value": "k2v1"
}
],
"created": "2019-09-19T00:29:04.703+0000",
"id": "k-PsRm0BBZeE7Tj3J_E_"
}
]
}
ERROR CODES
| Code | HTTP Status | Description | Example |
|---|---|---|---|
| 1007 | 404 | A record with requested id for products was not found |
Error Response 404 Expand source
{
"errors": [
{
"message": "A record with requested id [samples] for products was not found.",
"code": 1007,
"status": 404
}
]
}
|