Endpoint advertising.profiles returns the profiles, associated with the account.
AMALYZE Falcon API
advertising.profiles (POST)
Endpoint
Method
POST advertising.profiles
Example call
Shell
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
curl https://falcon.amalyze.com/<VERSION>/advertising.profiles \ -X POST \ -H "X-Falcon-Token: <YOUR-TOKEN-HERE>" \ -d ' { "pagination": { "size": 10, "page": 1 }, "filters: { "type": "seller" }, "sorting": [ { "direction": "asc", "column": "name" } ] }' |
JSON Payload
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
{ "pagination": { "size": 10, "page": 1 }, "filters: { "type": "seller" }, "sorting": [ { "direction": "asc", "column": "name" } ] } |
| Property | Type | Description | Further information |
pagination | object | Object containing the pagination information | pagination object definition |
filters | object | Object containing the filter information | |
filters.name | string | The advertiser profile’s name | optional |
filters.id | string | The advertiser profile’s name | optional |
filters.marketplace | string | The marketplace, the advertiser profile must be whitedlisted for | optional valid marketplaces |
filters.type | string | The type of the advertiser profile | optional
|
filters.query | string | Fulltext search over all available fields | optional |
sorting | array | Array containing the sorting information | |
sorting.column | string | The column to sort |
|
sorting.direction | string | The direction to sort | valid direction values |
JSON Response
JavaScript
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
{ "items": [ { "score": 100, "name": "AMALYZE AG", "id": "A16WAYYEQ3QXYH", "type": "seller", "marketplaces": { "A2EUQ1WTGCTBG2": { "active": false, "budgets": { "daily": null } }, "ATVPDKIKX0DER": { "active": false, "budgets": { "daily": null } }, "A1AM78C64UM0Y8": { "active": false, "budgets": { "daily": null } }, "A1RKKUPIHCS9HS": { "active": true, "budgets": { "daily": 999999999 } }, "A1F83G8C2ARO7P": { "active": true, "budgets": { "daily": 999999999 } }, "A13V1IB3VIYZZH": { "active": true, "budgets": { "daily": 999999999 } }, "A1PA6795UKMFR9": { "active": true, "budgets": { "daily": 999999999 } }, "APJ6JRA9NG5V4": { "active": true, "budgets": { "daily": 999999999 } } } } ], "pagination": { "filtered": 1 }, "request": { "id": "5f849803-3830-4677-bc0e-8acfae788a8a", "took": 0.0331, "costs": 0, "remaining": 100000, "method": "advertising.profiles", "success": true, "error": { "code": null, "message": null, "hint": null } } } |
| Property | Type | Description |
items | array | Array containing the accounts |
items.score | float | The (internal) score for the query |
items.name | string | The merchant / vendor name associated with the profile |
items.id | string | The merchant / vendor id associated with the profile |
items.type | string | The profile’s type (vendor / seller) |
items.marketplaces | object | Object containing information about the marketplaces |
items.marketplaces.marketplace | object | Object containing information about the specific marketplace valid properties:
|
items.marketplaces.marketplace.active | boolean | Indicates, if the profile has access to the specific marketplace |
items.marketplaces.marketplace.budgets | object | Object containing information about the budgets for the specific marketplace |
items.marketplaces.marketplae.budgets.daily | float | The daily budget for the specific marketplace |