{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.metapic.dev" } ], "info": { "name": "Metapic API docs", "_postman_id": "da4b5b59-d1cb-484c-b168-e5c15ad7b8bd", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Advertiser", "description": "", "item": [ { "name": "Creator Blocklist", "description": "Manages the creator blocklist for an advertiser.\n\nCreators added to the blocklist will not see the advertiser\nnor be able to convert links for that advertiser.", "item": [ { "name": "Gets the entries in the blocklist", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/blocklist", "query": [ { "key": "query", "value": "ytzfeimrfjitztzdaxexxp", "description": "Filters results to match user ID or username. Must not be greater than 128 characters.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/blocklist?query=ytzfeimrfjitztzdaxexxp", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "4", "description": "The ID of the advertiser." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"created_at\":null,\"created_by\":{\"id\":3982,\"username\":\"quinn.cronin\",\"display_name\":\"Aidan Ernser\",\"email\":\"littel.guillermo@example.org\",\"client_id\":4211,\"preferred_locale\":\"ti_ET\",\"language\":\"ti\"},\"client\":{\"id\":4212,\"name\":\"Dr. Cameron Abshire III\",\"client_id\":\"MIvie2C6Yo\",\"has_own_payment_system\":false,\"revenue_share\":1}},{\"id\":null,\"created_at\":null,\"created_by\":{\"id\":3983,\"username\":\"gbashirian\",\"display_name\":\"Josianne Feil\",\"email\":\"reilly.carli@example.com\",\"client_id\":4213,\"preferred_locale\":\"fil_PH\",\"language\":\"fil\"},\"client\":{\"id\":4214,\"name\":\"Marcellus McLaughlin\",\"client_id\":\"d9AtLmQOzS\",\"has_own_payment_system\":false,\"revenue_share\":1}}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Add entries to the blocklist", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/blocklist", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/blocklist", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "13", "description": "The ID of the advertiser." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"users\":[{\"id\":123,\"validate_clicks\":true},{\"id\":456,\"validate_clicks\":false}],\"user_tag_ids\":[10],\"client_ids\":[20]}" }, "description": "Adds the given entries to the blocklist,\nignoring them if they previously existed." }, "response": [] }, { "name": "Remove the target in the advertiser blocklist", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/blocklist\/:target_id", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/blocklist\/:target_id", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "16", "description": "The ID of the advertiser." }, { "id": "target_id", "key": "target_id", "value": "5", "description": "The ID of the target." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Order Collectors", "description": "", "item": [ { "name": "Get settings for sales pixel implementation", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser\/order-collectors\/sales-pixel", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser\/order-collectors\/sales-pixel", "variable": [ { "id": "advertiser", "key": "advertiser", "value": "et", "description": "The advertiser." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the settings to be added to the sales pixel script." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get order collector tracking settings", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser\/order-collectors\/:collector", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser\/order-collectors\/:collector", "variable": [ { "id": "advertiser", "key": "advertiser", "value": "temporibus", "description": "The advertiser." }, { "id": "collector", "key": "collector", "value": "woocommerce", "description": "The identifier of the collector" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the tracking configuration for the advertiser." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Activate tracking plugin", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/activate-tracking-plugin", "query": [], "raw": "{{baseUrl}}\/v2\/activate-tracking-plugin" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"metapic_activation_key\":\"optio\"}" }, "description": "Activates the tracking plugin with the given activation key.\n\nReturns the parameters to insert into the Javascript tracking snippet.", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Email quota", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/email-quota", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/email-quota", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "17", "description": "The ID of the advertiser." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns remaining email quota for the advertiser." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET v2\/advertisers\/{advertiser_id}\/payment-setup", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/payment-setup", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/payment-setup", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "15", "description": "The ID of the advertiser." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST v2\/advertisers\/{advertiser_id}\/payment-setup", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/payment-setup", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/payment-setup", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "1", "description": "The ID of the advertiser." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payment_setup_id\":\"sit\"}" }, "description": "" }, "response": [] }, { "name": "Url Matching Rules", "description": "Manages url matching rules for an advertiser.\nUrl Matching rule can either be to allow or to block matching of a URL\nbased on added rules.", "item": [ { "name": "List all url matching rules", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/url-matching-rules", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/url-matching-rules", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "1", "description": "The ID of the advertiser." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all url matching rules defined for the advertiser." }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":null,\"type\":null,\"is_main\":null,\"url\":\"testcompany.com\",\"updated_at\":null},{\"id\":null,\"type\":null,\"is_main\":null,\"url\":\"testcompany.com\",\"updated_at\":null}]", "name": "" } ] }, { "name": "Add new url matching rule", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/url-matching-rules", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/url-matching-rules", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "2", "description": "The ID of the advertiser." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"block\",\"url\":\"http:\\\/\\\/www.kirlin.org\\\/\",\"keyword\":\"ntrjo\",\"is_main\":true}" }, "description": "Adds a new rule to the url matching for the advertiser." }, "response": [] }, { "name": "Update url matching rule", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/url-matching-rules\/:urlMatchingRule_id", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/url-matching-rules\/:urlMatchingRule_id", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "20", "description": "The ID of the advertiser." }, { "id": "urlMatchingRule_id", "key": "urlMatchingRule_id", "value": "3", "description": "The ID of the urlMatchingRule." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"block\",\"url\":\"http:\\\/\\\/www.carroll.net\\\/\",\"keyword\":\"sqbm\",\"is_main\":false}" }, "description": "Updates existing url matching rule for the advertiser." }, "response": [] }, { "name": "Remove url matching rule", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/url-matching-rules\/:urlMatchingRule_id", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/url-matching-rules\/:urlMatchingRule_id", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "9", "description": "The ID of the advertiser." }, { "id": "urlMatchingRule_id", "key": "urlMatchingRule_id", "value": "19", "description": "The ID of the urlMatchingRule." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Removes existing url matching rule for the advertiser." }, "response": [] } ] }, { "name": "Create Advertiser Representative", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertiser-representatives", "query": [], "raw": "{{baseUrl}}\/v2\/advertiser-representatives" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My Store\",\"domains\":[[\"dev.test-test.com\"]],\"categories\":[7],\"logo_url\":\"http:\\\/\\\/jenkins.com\\\/quis-nostrum-vel-nisi-expedita.html\",\"country\":\" Example: SE\",\"currency\":\"Example: EUR\",\"language\":\"sv\",\"billing\":{\"company_name\":\"quia\",\"street\":\"provident\",\"postal_code\":\"harum\",\"city\":\"ut\",\"vat_number\":\"eaque\"}}" }, "description": "Creates a new Metapic user and self-service advertiser for the current session.\nRequires an Ory-issued JWT for a session not yet linked to a Metapic user (no metapic_user_id)." }, "response": [ { "header": [], "code": 201, "body": null, "name": "Created" }, { "header": [], "code": 409, "body": null, "name": "User with this email already exists" } ] }, { "name": "List stores", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores", "query": [ { "key": "query", "value": "nike", "description": "Query by either of the following: ID, store name.\n Returns all stores with id equal to `query` OR name contains `query`. Must not be greater than 255 characters.", "disabled": false }, { "key": "store_group_id", "value": "15", "description": "Query by store's store group. Returns all stores which belong to the given `store_group_id`.", "disabled": false }, { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 100.", "disabled": false }, { "key": "sort_by", "value": "magni", "description": "Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/stores?query=nike&store_group_id=15&size=20&sort_by=magni" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying & sorting all stores." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"Towne-Schultz\"},{\"id\":null,\"name\":\"Kemmer PLC\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Self-Service", "description": "", "item": [ { "name": "Create new self-service store", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores", "query": [], "raw": "{{baseUrl}}\/v2\/stores" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"My Store\",\"domains\":[[\"dev.test-test.com\"]],\"categories\":[12],\"logo_url\":\"http:\\\/\\\/ohara.org\\\/\",\"country\":\" Example: SE\",\"currency\":\"Example: EUR\",\"language\":\"sv\",\"billing\":{\"company_name\":\"non\",\"street\":\"dolore\",\"postal_code\":\"ex\",\"city\":\"voluptatum\",\"vat_number\":\"accusantium\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"name\":\"Bayer Inc\"}", "name": "" } ] }, { "name": "Deactivate advertiser", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:advertiser_id\/deactivate", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:advertiser_id\/deactivate", "variable": [ { "id": "advertiser_id", "key": "advertiser_id", "value": "15", "description": "The ID of the advertiser." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deactivates the advertiser." }, "response": [ { "header": [], "code": 200, "body": "App\\Http\\Resources\\Store\\StoreResource", "name": "" } ] } ] }, { "name": "GET v2\/users\/{user_id}\/stores-by-categories [DEPRECATED]", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/stores-by-categories", "query": [], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/stores-by-categories", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET v2\/users\/{user_id}\/stores-by-toplist [DEPRECATED]", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/stores-by-toplist", "query": [], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/stores-by-toplist", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List Creator Advertisers", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/advertisers", "query": [ { "key": "category_id", "value": "5", "description": "Filter by advertiser category. The ID of an existing record in the store_categories table. If not provided, returns recommended (toplist) advertisers. The id of an existing record in the store_categories table.", "disabled": false }, { "key": "include[0]", "value": "StoreCategories", "description": "Include optional relationships in the response. Options: mainUrlMatchingRule, StoreCategories.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "size", "value": "200", "description": "Number of items per page. Defaults to 200. Must not be greater than 200.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/advertisers?category_id=5&include[0]=StoreCategories&page=1&size=200", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns list of advertisers with commission rates, campaigns, and other relevant information for the creator." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":2300,\"name\":\"Price Group\",\"traffic_sources_costs\":[{\"source\":0,\"cpc\":100,\"cpc_v2\":{\"amount\":\"1\",\"currency\":\"EUR\"},\"cpa\":0.1,\"currency\":\"EUR\"}]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=2\",\"prev\":null,\"next\":\"\\\/?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":2,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":\"\\\/?page=2\",\"label\":\"2\",\"page\":2,\"active\":false},{\"url\":\"\\\/?page=2\",\"label\":\"Next »\",\"page\":2,\"active\":false}],\"path\":\"\\\/\",\"per_page\":1,\"to\":1,\"total\":2}}", "name": "" } ] }, { "name": "Accept invites for advertiser", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/me\/advertiser-invites", "query": [], "raw": "{{baseUrl}}\/v2\/me\/advertiser-invites" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Creates Metapic user and accepts all pending invites for advertiser" }, "response": [ { "header": [], "code": 204, "body": null, "name": "No content" }, { "header": [], "code": 404, "body": null, "name": "No pending advertiser invites found" }, { "header": [], "code": 409, "body": null, "name": "User with this email already exists" } ] } ] }, { "name": "Advertiser Groups", "description": "", "item": [ { "name": "List advertiser groups", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertiser-groups", "query": [ { "key": "return_ad_enabled", "value": "1", "description": "Only return advertiser groups which have return ads enabled.", "disabled": false }, { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 100.", "disabled": false }, { "key": "sort_by", "value": "illum", "description": "Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/advertiser-groups?return_ad_enabled=1&size=20&sort_by=illum" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying & sorting all advertiser groups." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":19,\"name\":\"Hahn-Ankunding\",\"key\":\"fr_BE\",\"currency\":\"USD\"},{\"id\":19,\"name\":\"Hahn-Ankunding\",\"key\":\"fr_BE\",\"currency\":\"USD\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] } ] }, { "name": "Affiliate Link", "description": "", "item": [ { "name": "Get an affiliate link", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/affiliate-links\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/affiliate-links\/:id", "variable": [ { "id": "id", "key": "id", "value": "excepturi", "description": "The ID of the affiliate link." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"http:\\\/\\\/www.kilback.com\\\/dolores-labore-in-pariatur-sequi\",\"original_url\":\"https:\\\/\\\/pouros.com\\\/occaecati-debitis-neque-pariatur-qui.html\",\"user_id\":3990,\"country\":\"LK\",\"provider\":\"silver\",\"advertiser\":{\"id\":2306,\"name\":\"Price-Abbott\"},\"title\":\"Dulce Kuhn\"}", "name": "" } ] }, { "name": "Create an affiliate link [DEPRECATED]", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/affiliate-links", "query": [], "raw": "{{baseUrl}}\/v2\/affiliate-links" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/advertiser.com\",\"advertiser_id\":6,\"advertiser_preview\":true,\"advertiser_group_id\":1,\"dry\":true}" }, "description": "Returns advertisers if there are multiple advertisers to match the url with. Otherwise, returns the affiliate link." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"affiliate_link\":{\"status\":\"success\",\"url\":\"https:\\\/\\\/cummings.com\\\/sequi-quam-et-dolor.html\",\"original_url\":\"http:\\\/\\\/www.wunsch.com\\\/nobis-eum-nam-voluptas-qui-quaerat-ad\",\"user_id\":3991,\"country\":\"KH\",\"provider\":\"gray\",\"advertiser\":{\"id\":2307,\"name\":\"Veum-Mayert\"},\"title\":\"Miss Mariana Heller DVM\"}}", "name": "" } ] }, { "name": "Create an affiliate link [DEPRECATED]", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/affiliate-links", "query": [], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/affiliate-links", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/advertiser.com\",\"advertiser_id\":11,\"advertiser_preview\":true,\"advertiser_group_id\":1,\"dry\":false}" }, "description": "Returns advertisers if there are multiple advertisers to match the url with. Otherwise, returns the affiliate link." }, "response": [ { "header": [], "code": 200, "body": "{\"status\":\"success\",\"affiliate_link\":{\"status\":\"success\",\"url\":\"http:\\\/\\\/www.gleason.com\\\/quia-rem-sit-voluptatem-inventore-sed\",\"original_url\":\"http:\\\/\\\/gottlieb.com\\\/\",\"user_id\":3992,\"country\":\"TL\",\"provider\":\"gray\",\"advertiser\":{\"id\":2308,\"name\":\"Walker Ltd\"},\"title\":\"Tanner Daugherty\"}}", "name": "" } ] }, { "name": "List affiliate links", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/affiliate-links", "query": [ { "key": "user_id", "value": "456", "description": "Filter affiliate links by creator (user) id. The id of an existing record in the users table.", "disabled": false }, { "key": "advertiser_id", "value": "123", "description": "Filter affiliate links by advertiser (store) id. The id of an existing record in the stores table.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter links created on or after this date (Y-m-d). Must be a valid date. Must be a date before or equal to date_to.", "disabled": false }, { "key": "date_to", "value": "2024-01-31", "description": "Filter links created on or before this date (Y-m-d). Must be a valid date. Must be a date after or equal to date_from.", "disabled": false }, { "key": "include[0]", "value": "stats", "description": "Include related data. When \"stats\" is included, the response will contain clicks, earnings, and potential earnings, and allow sorting by clicks and earnings.", "disabled": false }, { "key": "sort_by", "value": "created_at%3Adesc", "description": "Available column names: clicks, earnings, created_at. Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination. Must be at least 1.", "disabled": false }, { "key": "size", "value": "15", "description": "Number of items per page. Defaults to 20. Must be at least 1. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/affiliate-links?user_id=456&advertiser_id=123&date_from=2024-01-01&date_to=2024-01-31&include[0]=stats&sort_by=created_at%3Adesc&page=1&size=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of affiliate links associated with the creator." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"title\":\"Ramon Stark\",\"mtpc_url\":null,\"user_id\":3993,\"created_at\":null},{\"id\":null,\"title\":\"Mae Hessel\",\"mtpc_url\":null,\"user_id\":3994,\"created_at\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Inspect Affiliate Link", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/inspections\/affiliate-link", "query": [], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/inspections\/affiliate-link", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/advertiser.com\",\"ignore_advertiser_visibility\":true}" }, "description": "Determines convertibility of a URL, detects existing affiliate links, and returns matching advertisers when applicable." }, "response": [ { "header": [], "code": 200, "body": "{\n \"inspection_result\": \"single_advertiser\",\n \"matching_advertisers\": [\n {\n \"id\": 123,\n \"name\": \"Advertiser Name\",\n \"traffic_sources_costs\": [\n {\n \"id\": 15,\n \"source\": 0,\n \"cpc\": 100,\n \"cpc_v2\": {\n \"amount\": \"10\",\n \"currency\": \"EUR\"\n },\n \"currency\": \"EUR\"\n }\n ],\n \"... other StoreResource fields ... \"\n }\n ]}", "name": "" } ] }, { "name": "Convert an Affiliate Link", "request": { "url": { "host": "{{baseUrl}}", "path": "v3\/users\/:user_id\/affiliate-links", "query": [], "raw": "{{baseUrl}}\/v3\/users\/:user_id\/affiliate-links", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/advertiser.com\",\"advertiser_id\":1}" }, "description": "It converts url to an affiliate link." }, "response": [ { "header": [], "code": 200, "body": "{\"url\":\"http:\\\/\\\/homenick.org\\\/\",\"original_url\":\"http:\\\/\\\/oconner.com\\\/\",\"user_id\":3996,\"country\":\"MU\",\"provider\":\"teal\",\"advertiser\":{\"id\":2312,\"name\":\"Jacobson, Lakin and Koss\"},\"title\":\"Ms. Guadalupe Jenkins\"}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error_code\": \"no_matching_advertisers\",\n \"message\": \"No advertiser found\"\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error_code\": \"multiple_advertisers\",\n \"message\": \"Multiple advertisers match\"\n }", "name": "" } ] } ] }, { "name": "Agency", "description": "", "item": [ { "name": "Accept invites for agency", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/me\/agency-invites", "query": [], "raw": "{{baseUrl}}\/v2\/me\/agency-invites" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Creates Metapic user and accepts all pending invites for agency" }, "response": [ { "header": [], "code": 204, "body": null, "name": "No content" }, { "header": [], "code": 404, "body": null, "name": "No pending agency invites found" }, { "header": [], "code": 409, "body": null, "name": "User with this email already exists" } ] } ] }, { "name": "Client", "description": "", "item": [ { "name": "List clients", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/clients", "query": [ { "key": "query", "value": "internal+name", "description": "Query by id or name. Returns all clients where id is equal to `query` OR name contains `query` OR any revenue tier name contains `query`. Must not be greater than 128 characters.", "disabled": false }, { "key": "advertiser_group_ids[0]", "value": "1", "description": "Query by advertiser group. Returns all clients which belong to the given `advertiser_group_ids`.", "disabled": false }, { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 500.", "disabled": false }, { "key": "sort_by", "value": "voluptate", "description": "Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/clients?query=internal+name&advertiser_group_ids[0]=1&size=20&sort_by=voluptate" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying & sorting all clients." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":14,\"name\":\"Leda Sawayn\",\"client_id\":\"a0Y3vcZ5ah\",\"has_own_payment_system\":false,\"revenue_share\":1},{\"id\":14,\"name\":\"Leda Sawayn\",\"client_id\":\"a0Y3vcZ5ah\",\"has_own_payment_system\":false,\"revenue_share\":1}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] } ] }, { "name": "Creator Media", "description": "Operations on Media posted by Creators", "item": [ { "name": "Lists Creator generated media captured by Metapic.", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/user-media", "query": [ { "key": "query", "value": "provident", "description": "Filters media by username.", "disabled": false }, { "key": "status", "value": "all", "description": "Filter user media by show store value.", "disabled": false }, { "key": "type", "value": "instagram", "description": "Filters media by type.", "disabled": false }, { "key": "favorite", "value": "1", "description": "Filter user media by favorite value.", "disabled": false }, { "key": "group", "value": "12", "description": ":shrug:.", "disabled": false }, { "key": "format", "value": "csv", "description": "Format to export.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/user-media?query=provident&status=all&type=instagram&favorite=1&group=12&format=csv" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"media_type\": \"youtube\",\n \"media_id\": \"FLR0BB4qDt8\",\n \"username\": \"hamida_most\",\n \"tag_id\": null,\n \"user_id\": null,\n \"favorite\": 1,\n \"show_store\": 1,\n \"published_at\": \"2023-05-13\",\n \"created_at\": \"2023-07-18T12:02:53.000000Z\",\n \"updated_at\": \"2023-07-18T12:09:13.000000Z\"\n },\n {\n \"id\": 2,\n \"media_type\": \"tiktok\",\n \"username\": \"juliaringblomm\",\n \"tag_id\": null,\n \"user_id\": null,\n \"favorite\": 1,\n \"show_store\": 0,\n \"published_at\": \"2023-06-17\",\n \"created_at\": \"2023-07-18T12:10:49.000000Z\",\n \"updated_at\": \"2023-07-18T13:39:28.000000Z\",\n \"media\": {\n \"content_type\": \"video\/mp4\",\n \"href\": \"https:\/\/metapic-tiktok-media.example\/juliaringblomm\/7245692137566653722\"\n }\n },\n {\n \"id\": 3,\n \"media_type\": \"instagram\",\n \"username\": \"juliaringblomm\",\n \"tag_id\": null,\n \"user_id\": null,\n \"favorite\": 1,\n \"show_store\": 0,\n \"published_at\": \"2023-06-17\",\n \"created_at\": \"2023-07-18T12:10:49.000000Z\",\n \"updated_at\": \"2023-07-18T13:39:28.000000Z\",\n \"media\": {\n \"content_type\": \"video\/mp4\",\n \"href\": \"https:\/\/metapic-instragram-media.example\/juliaringblomm\/7245692137566653722\"\n }\n },\n {\n \"id\": 4,\n \"media_type\": \"instagram\",\n \"username\": \"juliaringblomm\",\n \"tag_id\": null,\n \"user_id\": null,\n \"favorite\": 1,\n \"show_store\": 0,\n \"published_at\": \"2023-06-17\",\n \"created_at\": \"2023-07-18T12:10:49.000000Z\",\n \"updated_at\": \"2023-07-18T13:39:28.000000Z\",\n \"media\": {\n \"content_type\": \"image\/jpeg\",\n \"href\": \"https:\/\/metapic-instragram-media.example\/juliaringblomm\/7245692137566653722\"\n }\n }\n ],\n \"first_page_url\": \"http:\\\/\\\/metapic-api.my\\\/user-media?page=1\",\n \"from\": 1,\n \"last_page\": 3,\n \"last_page_url\": \"http:\\\/\\\/metapic-api.my\\\/user-media?page=3\",\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"http:\\\/\\\/metapic-api.my\\\/user-media?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"http:\\\/\\\/metapic-api.my\\\/user-media?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"http:\\\/\\\/metapic-api.my\\\/user-media?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"http:\\\/\\\/metapic-api.my\\\/user-media?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"next_page_url\": \"http:\/\/metapic-api.my\/user-media?page=2\",\n \"path\": \"http:\/\/metapic-api.my\/user-media\",\n \"per_page\": 5,\n \"prev_page_url\": null,\n \"to\": 5,\n \"total\": 12\n}\n", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "GET v2\/health", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/health", "query": [], "raw": "{{baseUrl}}\/v2\/health" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 200, "body": "{\"status\":\"up\"}", "name": "" } ] }, { "name": "Get Store Categories", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/store-categories", "query": [], "raw": "{{baseUrl}}\/v2\/store-categories" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":null,\"name\":\"Food\"},{\"id\":null,\"name\":\"Fashion\"}]", "name": "" } ] }, { "name": "Get all invoices for a payment period as a zip.", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/payments\/getPaymentInvoices", "query": [], "raw": "{{baseUrl}}\/v2\/payments\/getPaymentInvoices" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payment_period\":\"2026-04\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get Payments parts by user, grouped by months and stores", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/payments\/upload-ax-id-matching", "query": [], "raw": "{{baseUrl}}\/v2\/payments\/upload-ax-id-matching" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"file\":\"mdzlvumwlrkhbjwuzok\"}" }, "description": "" }, "response": [] }, { "name": "Mark Payments as paid", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/payments\/mark-invoices-as-paid", "query": [], "raw": "{{baseUrl}}\/v2\/payments\/mark-invoices-as-paid" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"file\":\"vqidnneydehcsoerkjywkznqo\"}" }, "description": "" }, "response": [] }, { "name": "Creator Invoice Generation", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/payments\/generate-creator-invoice\/:paymentId", "query": [], "raw": "{{baseUrl}}\/v2\/payments\/generate-creator-invoice\/:paymentId", "variable": [ { "id": "paymentId", "key": "paymentId", "value": "enim", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for generating a creator invoice from external component" }, "response": [] }, { "name": "List PaymentSystemConfig", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/payments\/systems-config", "query": [ { "key": "date", "value": "2021-01-11", "description": "The payment date. Example: 2021-01-11. Must be a valid date.", "disabled": false }, { "key": "client_id", "value": "2", "description": "Filter by client ID. The id of an existing record in the clients table.", "disabled": false }, { "key": "user_id", "value": "15", "description": "Filter by user ID. The id of an existing record in the users table.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/payments\/systems-config?date=2021-01-11&client_id=2&user_id=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying the current payment systems configuration" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update PaymentSystemConfig", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/payments\/systems-config", "query": [], "raw": "{{baseUrl}}\/v2\/payments\/systems-config" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"date\":\"2026-04-21T17:38:00\",\"client_id\":2,\"user_id\":15,\"system\":0,\"ignore_lock\":true}" }, "description": "Endpoint for updating the current payment systems configuration" }, "response": [] } ] }, { "name": "Entrypoint", "description": "", "item": [ { "name": "App's entrypoint", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/entrypoint", "query": [], "raw": "{{baseUrl}}\/v2\/entrypoint" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"app\":\"admin\",\"store_id\":19}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Notification", "description": "", "item": [ { "name": "Proxy any request to notification service", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/notifications-proxy\/:path", "query": [], "raw": "{{baseUrl}}\/v2\/notifications-proxy\/:path", "variable": [ { "id": "path", "key": "path", "value": "", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Offer", "description": "", "item": [ { "name": "Create campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores\/:store_id\/offers", "query": [], "raw": "{{baseUrl}}\/v2\/stores\/:store_id\/offers", "variable": [ { "id": "store_id", "key": "store_id", "value": "15", "description": "The store ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"store_group_id\":2,\"type\":\"suggestion\",\"name\":\"Summer campaign for VIP creators\",\"campaign_title\":\"Summer campaign\",\"campaign_text\":\"This is a summer campaign!\",\"has_product_seeding\":false,\"has_onetime_payment\":true,\"per_user_limit\":false,\"one_time_payment\":38330.407566,\"budget_limit\":17,\"max_clicks\":4,\"valid_from\":\"2026-04-21T17:37:57\",\"valid_until\":\"1979-01-21\",\"todo\":[\"ldhn\"],\"show_for_advertiser\":false,\"priority_after\":18,\"shared_budget_id\":1,\"shared_budget\":{\"title\":\"Summer budget\",\"amount\":10000},\"targets\":{\"user_ids\":[20],\"user_tag_ids\":[13],\"store_group_ids\":[2],\"emails\":[\"rowan02@example.net\"],\"social_media_identifiers\":[\"glwn\"],\"client_ids\":[13],\"revenue_tier_ids\":[11]},\"traffic_sources_costs\":[{\"source\":1,\"cpc\":230,\"cpa\":0.2,\"invoice_cpc\":250,\"invoice_cpa\":0.25,\"user_revenue\":1}]}" }, "description": "Creates new campaign for a store." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"campaign_title\":\"Sophia McGlynn\",\"campaign_text\":\"Eos officia aut omnis ipsa. Qui perspiciatis incidunt beatae maiores corporis inventore. Eius labore nisi ducimus doloribus illo. Pariatur dignissimos reprehenderit excepturi suscipit placeat.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NWVlP3RleHQ9c2FlcGU=\",\"image\":null,\"store_id\":2266,\"token\":\"ygr3oko2ttosxje4\",\"type\":\"standard\",\"warnings\":{\"skipped_targets\":{\"user_ids\":[12,15]}}},\"warnings\":{\"skipped_targets\":{\"user_ids\":[12,15]}}}", "name": "" } ] }, { "name": "Display campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns information about a specific campaign." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"campaign_title\":\"Ms. Susie Bayer III\",\"campaign_text\":\"Deleniti sint sunt est dicta nostrum recusandae et. Aut nesciunt et ab ipsam. Sint omnis ut est enim est cumque. Sint numquam sit quia aspernatur inventore.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWNjP3RleHQ9ZW5pbQ==\",\"image\":null,\"store_id\":2267,\"token\":\"74p78l1tkoq80ceh\",\"type\":\"standard\"}", "name": "" } ] }, { "name": "Update campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the offer." }, { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"store_group_id\":2,\"type\":\"user_accept\",\"name\":\"Summer campaign for VIP creators\",\"campaign_title\":\"Summer campaign\",\"campaign_text\":\"This is a summer campaign!\",\"has_product_seeding\":false,\"has_onetime_payment\":true,\"per_user_limit\":true,\"one_time_payment\":1422065.534606359,\"budget_limit\":14,\"max_clicks\":20,\"valid_from\":\"2026-04-21T17:37:57\",\"valid_until\":\"1971-02-21\",\"todo\":[\"eypzztujgk\"],\"show_for_advertiser\":false,\"priority_after\":8,\"traffic_sources_costs\":[{\"source\":1,\"cpc\":230,\"cpa\":0.2,\"invoice_cpc\":250,\"invoice_cpa\":0.25,\"user_revenue\":1}],\"targets\":{\"0\":[],\"user_ids\":[19],\"user_tag_ids\":[2],\"store_group_ids\":[6],\"emails\":[\"adelle.pfeffer@example.net\"],\"social_media_identifiers\":[\"xnxuqznswhbsgvdovy\"],\"client_ids\":[4],\"revenue_tier_ids\":[1]},\"shared_budget_id\":1,\"shared_budget\":{\"title\":\"Summer budget\",\"amount\":10000}}" }, "description": "Updates existing campaign." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":null,\"campaign_title\":\"Nigel Jakubowski\",\"campaign_text\":\"Ipsam repellendus in non ut vero aut. Aspernatur molestias itaque est itaque esse similique temporibus ex. Autem earum illo hic nostrum et.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYjIyP3RleHQ9Y3VtcXVl\",\"image\":null,\"store_id\":2268,\"token\":\"34vwzp2c8fij0jxm\",\"type\":\"standard\",\"warnings\":{\"skipped_targets\":{\"user_ids\":[12,15]}}},\"warnings\":{\"skipped_targets\":{\"user_ids\":[12,15]}}}", "name": "" } ] }, { "name": "Delete campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:id", "variable": [ { "id": "id", "key": "id", "value": "20", "description": "The ID of the offer." }, { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Soft deletes a campaign." }, "response": [] }, { "name": "List campaigns", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers", "query": [ { "key": "query", "value": "black+friday", "description": "Query by either of the following: ID, internal name, title.\n Returns all offers with id equal to `query` OR name contains `query` OR campaign_title contains `query`. Must not be greater than 64 characters.", "disabled": false }, { "key": "statuses[0]", "value": "ended", "description": "", "disabled": false }, { "key": "store_ids[0]", "value": "1", "description": "Query by offer's store. Returns all offers which belong to the given `store_ids`.", "disabled": false }, { "key": "store_group_ids[0]", "value": "1", "description": "Query by offer's store group. Returns all offers which belong to the given `store_group_ids`.", "disabled": false }, { "key": "created_by", "value": "13", "description": "Query by offer's author ID. Returns all offers created by the user making the request", "disabled": false }, { "key": "or_id", "value": "1234", "description": "Query by offer's ID. Performs an 'OR' search, compared to 'AND' search for other filters,\n so an offer with given ID is always included in the results, if matched.", "disabled": false }, { "key": "target_user_id", "value": "10", "description": "", "disabled": false }, { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 100.", "disabled": false }, { "key": "sort_by", "value": "fugiat", "description": "Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false }, { "key": "custom_sort_by", "value": "ends_soon", "description": "", "disabled": false }, { "key": "include[]", "value": "", "description": "", "disabled": true }, { "key": "format", "value": "xlsx", "description": "", "disabled": false }, { "key": "show_for_advertiser", "value": "1", "description": "Admin-only filter offers by visibility on the advertiser.", "disabled": false }, { "key": "advertiser_id", "value": "123", "description": "Filter offers by advertiser. Required when filtering as non-admin.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/offers?query=black+friday&statuses[0]=ended&store_ids[0]=1&store_group_ids[0]=1&created_by=13&or_id=1234&target_user_id=10&size=20&sort_by=fugiat&custom_sort_by=ends_soon&include[]=&format=xlsx&show_for_advertiser=1&advertiser_id=123" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying & sorting all campaigns." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"campaign_title\":\"Jakob Schamberger\",\"campaign_text\":\"Veritatis iure voluptas voluptatem quod mollitia. Provident velit cupiditate nisi porro voluptates quia. Libero autem hic deleniti exercitationem. Harum earum est cum sunt.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODExP3RleHQ9aXVyZQ==\",\"image\":null,\"store_id\":2269,\"token\":\"hvsqdg7bxqck7daw\",\"type\":\"standard\"},{\"id\":null,\"campaign_title\":\"Magnolia Weimann\",\"campaign_text\":\"Quas ipsa tempora libero quis sint ea adipisci. Vel hic est quam et quia. Expedita illo sequi culpa eos aperiam voluptatem.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzc3P3RleHQ9YXV0\",\"image\":null,\"store_id\":2270,\"token\":\"ce0uwneo3c4mpsjl\",\"type\":\"standard\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Upload campaign image", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/uploads", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/uploads", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"default\":\"dolore\"}" }, "description": "Uploads an image to a campaign." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"campaign_title\":\"Dr. Easton Bechtelar\",\"campaign_text\":\"Voluptatibus numquam iste doloremque dignissimos. Quam expedita facere et qui tenetur.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWNjP3RleHQ9bnVtcXVhbQ==\",\"image\":null,\"store_id\":2271,\"token\":\"ioimtggcghmngfaq\",\"type\":\"standard\"}", "name": "" } ] }, { "name": "Pause campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/pause", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/pause", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"campaign_title\":\"Kacey Orn\",\"campaign_text\":\"Rem sed eos rerum eos odit. Beatae beatae quasi tenetur cumque omnis aut. Eligendi nulla aut vitae consectetur dolore delectus. Amet illum at autem quo dolor.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWVlP3RleHQ9dm9sdXB0YXRlcw==\",\"image\":null,\"store_id\":2272,\"token\":\"pj5p7g1p6alhuh5h\",\"type\":\"standard\"}", "name": "" } ] }, { "name": "Unpause campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/unpause", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/unpause", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"campaign_title\":\"Gracie Eichmann PhD\",\"campaign_text\":\"Et eum harum non facere. Eligendi facilis possimus autem quaerat ducimus est. Assumenda reiciendis itaque repellendus eaque. Quia distinctio debitis quod repellat itaque nostrum et.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NjMzP3RleHQ9aWQ=\",\"image\":null,\"store_id\":2273,\"token\":\"lpvb6tkefsy6sykk\",\"type\":\"standard\"}", "name": "" }, { "header": [], "code": 400, "body": null, "name": "Bad Request" } ] }, { "name": "Display campaign stats", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/stats", "query": [ { "key": "start_date", "value": "2023-01-01", "description": "The start date for the stats period (YYYY-MM-DD)", "disabled": false }, { "key": "end_date", "value": "2023-01-31", "description": "The end date for the stats period (YYYY-MM-DD)", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/stats?start_date=2023-01-01&end_date=2023-01-31", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"1999-10-31\",\"end_date\":\"2119-02-11\"}" }, "description": "Returns statistics about a specific campaign." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Add affiliate link to campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/affiliate-links\/:tag_id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/affiliate-links\/:tag_id", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "19", "description": "The ID of the offer." }, { "id": "tag_id", "key": "tag_id", "value": "15", "description": "The ID of the tag." }, { "id": "offer", "key": "offer", "value": "456", "description": "The campaign (offer) ID." }, { "id": "tag", "key": "tag", "value": "123", "description": "The affiliate link (tag) ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": null, "name": "Affiliate link added to campaign" } ] }, { "name": "Remove affiliate link from campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/affiliate-links\/:tag_id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/affiliate-links\/:tag_id", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "6", "description": "The ID of the offer." }, { "id": "tag_id", "key": "tag_id", "value": "14", "description": "The ID of the tag." }, { "id": "offer", "key": "offer", "value": "456", "description": "The campaign (offer) ID." }, { "id": "tag", "key": "tag", "value": "123", "description": "The affiliate link (tag) ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": null, "name": "Affiliate link removed from campaign" } ] }, { "name": "Offer Target", "description": "", "item": [ { "name": "Get targets for offer", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/targets", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/targets", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Add new targets to offer", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/targets", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/targets", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_ids\":[7],\"user_tag_ids\":[13],\"store_group_ids\":[14],\"emails\":[\"bryana60@example.com\"],\"social_media_identifiers\":[\"qgtpekxwuujkq\"],\"client_ids\":[14],\"revenue_tier_ids\":[2]}" }, "description": "" }, "response": [] } ] }, { "name": "Get User Campaigns", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/offers", "query": [ { "key": "status", "value": "accepted", "description": "DEPRECATED. Use `statuses` instead. Cannot be used together with `statuses`.", "disabled": false }, { "key": "name", "value": "Nike", "description": "Filter campaigns by name. Must not be greater than 128 characters.", "disabled": false }, { "key": "participant_statuses[0]", "value": "second_prio", "description": "Filter by multiple participant statuses.", "disabled": false }, { "key": "campaign_statuses[0]", "value": "scheduled", "description": "Filter by multiple campaign statuses.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "size", "value": "30", "description": "Number of items per page. Defaults to 30. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/offers?status=accepted&name=Nike&participant_statuses[0]=second_prio&campaign_statuses[0]=scheduled&page=1&size=30", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns campaigns that are not of type \"standard\" with additional information about user participation. It also allows filtering by title, multiple campaign and participant statuses." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"campaign_title\":\"Mckenzie Huel\",\"campaign_text\":\"Ut exercitationem doloremque accusantium ea aut modi ipsum. Nobis atque aut in error. Rem labore qui cumque et temporibus consequatur voluptate.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmRkP3RleHQ9ZG9sb3I=\",\"image\":null,\"store_id\":2302,\"token\":\"c7ouogqd3f2ci52a\",\"type\":\"standard\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=2\",\"prev\":null,\"next\":\"\\\/?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":2,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":\"\\\/?page=2\",\"label\":\"2\",\"page\":2,\"active\":false},{\"url\":\"\\\/?page=2\",\"label\":\"Next »\",\"page\":2,\"active\":false}],\"path\":\"\\\/\",\"per_page\":1,\"to\":1,\"total\":2}}", "name": "" } ] }, { "name": "Get User Campaigns", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/campaigns", "query": [ { "key": "status", "value": "accepted", "description": "DEPRECATED. Use `statuses` instead. Cannot be used together with `statuses`.", "disabled": false }, { "key": "name", "value": "Nike", "description": "Filter campaigns by name. Must not be greater than 128 characters.", "disabled": false }, { "key": "participant_statuses[0]", "value": "product_sent", "description": "Filter by multiple participant statuses.", "disabled": false }, { "key": "campaign_statuses[0]", "value": "active", "description": "Filter by multiple campaign statuses.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number for pagination.", "disabled": false }, { "key": "size", "value": "30", "description": "Number of items per page. Defaults to 30. Must not be greater than 100.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/campaigns?status=accepted&name=Nike&participant_statuses[0]=product_sent&campaign_statuses[0]=active&page=1&size=30", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns campaigns that are not of type \"standard\" with additional information about user participation. It also allows filtering by title, multiple campaign and participant statuses." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"campaign_title\":\"Kaya Herzog\",\"campaign_text\":\"Ipsam saepe et quidem tempore. Est architecto a perferendis esse sint. Aut qui soluta eum sit qui eius odio. Nihil ipsum velit incidunt excepturi ut id.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjU1P3RleHQ9cXVvZA==\",\"image\":null,\"store_id\":2304,\"token\":\"wp7nhzy3ucru4t67\",\"type\":\"standard\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=2\",\"prev\":null,\"next\":\"\\\/?page=2\"},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":2,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":\"\\\/?page=2\",\"label\":\"2\",\"page\":2,\"active\":false},{\"url\":\"\\\/?page=2\",\"label\":\"Next »\",\"page\":2,\"active\":false}],\"path\":\"\\\/\",\"per_page\":1,\"to\":1,\"total\":2}}", "name": "" } ] }, { "name": "Display campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-by-token\/:offer_token", "query": [], "raw": "{{baseUrl}}\/v2\/offer-by-token\/:offer_token", "variable": [ { "id": "offer_token", "key": "offer_token", "value": "assumenda", "description": "" }, { "id": "offer_id", "key": "offer_id", "value": "15556", "description": "The offer ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns information about a specific campaign." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"campaign_title\":\"Della Crona\",\"campaign_text\":\"Optio perferendis ut at et. Et voluptate voluptas sit eum. Et voluptas sint quis totam aut qui consectetur.\",\"has_product_seeding\":false,\"has_onetime_payment\":false,\"status\":\"active\",\"image_url\":\"https:\\\/\\\/media.metapic.com\\\/insecure\\\/rs:fill:800:500\\\/g:sm\\\/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjc3P3RleHQ9YWxpcXVhbQ==\",\"image\":null,\"store_id\":2311,\"token\":\"kgo5qzxxk2h2f5z1\",\"type\":\"standard\"}", "name": "" } ] } ] }, { "name": "Offer Participant", "description": "", "item": [ { "name": "Checks if user has been added to the offer.", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/users\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/users\/:id", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "9", "description": "The ID of the offer." }, { "id": "id", "key": "id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Comment", "description": "", "item": [ { "name": "Add OfferUser comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-users\/:offer_user_id\/comments", "query": [], "raw": "{{baseUrl}}\/v2\/offer-users\/:offer_user_id\/comments", "variable": [ { "id": "offer_user_id", "key": "offer_user_id", "value": "1", "description": "The ID of the offerUser." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"stszgth\"}" }, "description": "" }, "response": [] }, { "name": "Update OfferUser comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-users\/:offer_user_id\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/offer-users\/:offer_user_id\/comments\/:id", "variable": [ { "id": "offer_user_id", "key": "offer_user_id", "value": "1", "description": "The ID of the offerUser." }, { "id": "id", "key": "id", "value": "1", "description": "The ID of the comment." }, { "id": "offer_comment_id", "key": "offer_comment_id", "value": "1", "description": "The ID of the comment." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment\":\"gsszbgr\"}" }, "description": "" }, "response": [] }, { "name": "Delete OfferUser comment", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-users\/:offer_user_id\/comments\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/offer-users\/:offer_user_id\/comments\/:id", "variable": [ { "id": "offer_user_id", "key": "offer_user_id", "value": "1", "description": "The ID of the offerUser." }, { "id": "id", "key": "id", "value": "4", "description": "The ID of the comment." }, { "id": "offerCommentId", "key": "offerCommentId", "value": "1", "description": "The ID of the comment." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Activity", "description": "", "item": [ { "name": "Get the list of activities on OfferUser card", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-users\/:offer_user\/activities", "query": [], "raw": "{{baseUrl}}\/v2\/offer-users\/:offer_user\/activities", "variable": [ { "id": "offer_user", "key": "offer_user", "value": "quasi", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"include\":[\"has_unread_notification\"]}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "List participants in a campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "9", "description": "The ID of the offer." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"query\":\"cbap\",\"status\":\"applied\",\"include\":[\"offer_comments_count\"]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"offer_id\":814,\"user_id\":null,\"display_name\":\"freida98\",\"clicks\":5571,\"status\":\"store_denied\",\"pre_registered_identifier\":\"freida98\",\"todo\":null,\"payment_amount\":null},{\"id\":null,\"offer_id\":815,\"user_id\":null,\"display_name\":\"leila93\",\"clicks\":75976607,\"status\":\"denied\",\"pre_registered_identifier\":\"leila93\",\"todo\":null,\"payment_amount\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get participant details", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants\/:id", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "17", "description": "The ID of the offer." }, { "id": "id", "key": "id", "value": "3", "description": "The ID of the participant." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"offer_id\":816,\"user_id\":3956,\"display_name\":\"hleuschke\",\"clicks\":675956,\"status\":\"denied\",\"todo\":null,\"payment_amount\":null}", "name": "" } ] }, { "name": "Retrieve participants statistics for an offer", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants-stats", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants-stats", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "1", "description": "The ID of the offer." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"query\":\"dleoanixswympfvvk\",\"active\":false,\"start_date\":\"2011-11-20\",\"end_date\":\"2103-02-15\",\"sort_by\":\"clicks:asc\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"user_id\":null,\"display_name\":null,\"clicks\":0,\"status\":null,\"links_created\":null,\"estimated_gp\":null,\"estimated_earning_to_cost_ratio\":null},{\"id\":null,\"user_id\":null,\"display_name\":null,\"clicks\":0,\"status\":null,\"links_created\":null,\"estimated_gp\":null,\"estimated_earning_to_cost_ratio\":null}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":10,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Retrieve participants count by active\/inactive", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants-count-by-click-activity", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants-count-by-click-activity", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "5", "description": "The ID of the offer." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"start_date\":\"2010-09-17\",\"end_date\":\"2067-10-21\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "300" }, { "key": "x-ratelimit-remaining", "value": "300" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update participant status", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants\/:participant_id\/update-status", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants\/:participant_id\/update-status", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "1", "description": "The ID of the offer." }, { "id": "participant_id", "key": "participant_id", "value": "7", "description": "The ID of the participant." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"accepted\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"offer_id\":817,\"user_id\":null,\"display_name\":\"lehner.myrtice\",\"clicks\":1832327,\"status\":\"applied\",\"pre_registered_identifier\":\"lehner.myrtice\",\"todo\":null,\"payment_amount\":null}", "name": "" } ] }, { "name": "Update participant todo", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants\/:participant_id\/todo", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants\/:participant_id\/todo", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "13", "description": "The ID of the offer." }, { "id": "participant_id", "key": "participant_id", "value": "3", "description": "The ID of the participant." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"todo\":[{\"key\":\"qahsblejc\",\"value\":true}]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"offer_id\":818,\"user_id\":null,\"display_name\":\"johnathon29\",\"clicks\":896473,\"status\":\"done\",\"pre_registered_identifier\":\"johnathon29\",\"todo\":null,\"payment_amount\":null}", "name": "" } ] }, { "name": "Update participant payment amount", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants\/:participant_id\/payment-amount", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants\/:participant_id\/payment-amount", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "4", "description": "The ID of the offer." }, { "id": "participant_id", "key": "participant_id", "value": "9", "description": "The ID of the participant." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payment_amount\":{\"amount\":\"1.2\",\"currency\":\"EUR\"}}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"offer_id\":819,\"user_id\":3959,\"display_name\":null,\"clicks\":8188732,\"status\":\"accepted\",\"todo\":null,\"payment_amount\":null}", "name": "" } ] }, { "name": "Set\/override click limit", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants\/:participant_id\/overrides\/clicks", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants\/:participant_id\/overrides\/clicks", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15", "description": "The ID of the offer." }, { "id": "participant_id", "key": "participant_id", "value": "15", "description": "The ID of the participant." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"click_limit\":5}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"offer_id\":820,\"user_id\":null,\"display_name\":\"eugene.effertz@hotmail.com\",\"clicks\":5460,\"status\":\"done\",\"pre_registered_email\":\"eugene.effertz@hotmail.com\",\"todo\":null,\"payment_amount\":null}", "name": "" } ] }, { "name": "Override campaign's costs", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offers\/:offer_id\/participants\/:participant_id\/overrides\/costs", "query": [], "raw": "{{baseUrl}}\/v2\/offers\/:offer_id\/participants\/:participant_id\/overrides\/costs", "variable": [ { "id": "offer_id", "key": "offer_id", "value": "15", "description": "The ID of the offer." }, { "id": "participant_id", "key": "participant_id", "value": "8", "description": "The ID of the participant." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"traffic_sources_costs\":[{\"source\":1,\"cpc\":{\"amount\":\"1.2\",\"currency\":\"EUR\"},\"cpa\":0.2}]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"offer_id\":821,\"user_id\":3962,\"display_name\":null,\"clicks\":193262947,\"status\":\"second_prio\",\"todo\":null,\"payment_amount\":null}", "name": "" } ] }, { "name": "Checks if user has been added to the offer.", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-by-token\/:offer_token\/users\/:user_id", "query": [], "raw": "{{baseUrl}}\/v2\/offer-by-token\/:offer_token\/users\/:user_id", "variable": [ { "id": "offer_token", "key": "offer_token", "value": "explicabo", "description": "" }, { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" }, { "key": "access-control-expose-headers", "value": "Content-Disposition" }, { "key": "set-cookie", "value": "metapic_session=eyJpdiI6InRUWEpuYkkyMlZVWU80WkV1cjEwMXc9PSIsInZhbHVlIjoiZjNyMkRqNkJnd1NvUDVaRjNLSnFLVE9iWkRCMmdTcWVoTjUyd2Y4VmJXbmpaUEczNkNQbUs0b0NXOXFIL3RXUjdzVDFxd2oyaFZ2Vk9GRy8vWFB1UWcyTWlEcmlBWkxIbHdpWi9DcUlGTkNkdHJGeHZwWnJOL3d2ckVaVzVia3ciLCJtYWMiOiJlMjM0OTM2ZDU1YTlmYWFlYzk2NmFmMGYwZTRjNjQzMTkzNjliYTA3Y2YxOGY0ZjBlNDljNzc0ZTIxNGM0OWI5IiwidGFnIjoiIn0%3D; expires=Tue, 21 Apr 2026 17:38:00 GMT; Max-Age=7200; path=\/; secure; httponly" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Mark user as having joined the campaign", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/offer-by-token\/:offer_token\/users\/:user_id\/join", "query": [], "raw": "{{baseUrl}}\/v2\/offer-by-token\/:offer_token\/users\/:user_id\/join", "variable": [ { "id": "offer_token", "key": "offer_token", "value": "voluptas", "description": "" }, { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This can only be performed by the user themselves." }, "response": [] } ] }, { "name": "Ory", "description": "", "item": [ { "name": "Identity Created", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/webhooks\/ory\/identities\/created", "query": [], "raw": "{{baseUrl}}\/v2\/webhooks\/ory\/identities\/created" }, "method": "POST", "header": [ { "key": "mtpc-api-key", "value": "{mtpc-api-key}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"identity\":{\"id\":\"ory_identity_id_123\",\"traits\":{\"email\":\"user@example.com\"}},\"app_url\":\"https:\\\/\\\/advertiser.metapic.com\"}" }, "description": "Creates a Hubspot deal for advertiser representative when triggered by an Ory registration.after webhook.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Identity updated", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/webhooks\/ory\/identities\/updated", "query": [], "raw": "{{baseUrl}}\/v2\/webhooks\/ory\/identities\/updated" }, "method": "POST", "header": [ { "key": "mtpc-api-key", "value": "{mtpc-api-key}" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"identity\":{\"id\":\"ory_identity_id_123\",\"traits\":{\"email\":\"user@example.com\"}}}" }, "description": "Updates a user when triggered by an Ory settings.after webhook.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Return Ads", "description": "", "item": [ { "name": "List Return Ads", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads", "query": [ { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 100.", "disabled": false }, { "key": "query", "value": "internal+name", "description": "Query by either of the following: ID or name.\n Returns all return ads with id equal to `query` OR name contains `query`. Must not be greater than 64 characters.", "disabled": false }, { "key": "advertiser_group_ids[0]", "value": "1", "description": "Query by return ad's advertiser group. Returns all return ads which belong to the given `advertiser_group_ids`.", "disabled": false }, { "key": "advertiser_ids[0]", "value": "1", "description": "Query by return ad's advertiser. Returns all return ads which belong to the given `advertiser_ids`.", "disabled": false }, { "key": "statuses[0]", "value": "scheduled", "description": "", "disabled": false }, { "key": "created_by", "value": "", "description": "", "disabled": true }, { "key": "or_id", "value": "1234", "description": "Query by return ad's ID. Performs an 'OR' search, compared to 'AND' search for other filters,\n so an return ad with given ID is always included in the results, if matched.", "disabled": false }, { "key": "sort_by", "value": "current_clicks%3Aasc", "description": "Query sorted by (name, created_at, starts_at, ends_at, current_clicks, current_views, order_count, order_value, earnings or click_through_rate). Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/return-ads?size=20&query=internal+name&advertiser_group_ids[0]=1&advertiser_ids[0]=1&statuses[0]=scheduled&created_by=&or_id=1234&sort_by=current_clicks%3Aasc" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Paginated list of Return Ads" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"Myrtie Rowe\",\"advertiser_group_id\":4937,\"affiliate_link\":{\"id\":883,\"url\":\"http:\\\/\\\/stroman.info\\\/ea-sequi-in-ut-fugit-velit.html\",\"original_url\":\"http:\\\/\\\/www.bartell.com\\\/\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/883\",\"user_id\":3964,\"country\":\"LS\",\"provider\":\"lime\",\"advertiser\":{\"id\":2287,\"name\":\"Heller PLC\"},\"title\":\"Joesph Gibson\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3965,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.502141Z\",\"ends_at\":\"2026-05-21T15:37:59.502208Z\",\"stats\":[]},{\"id\":null,\"name\":\"Conner Paucek\",\"advertiser_group_id\":4940,\"affiliate_link\":{\"id\":884,\"url\":\"http:\\\/\\\/rempel.com\\\/\",\"original_url\":\"http:\\\/\\\/www.smitham.com\\\/\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/884\",\"user_id\":3966,\"country\":\"VU\",\"provider\":\"yellow\",\"advertiser\":{\"id\":2288,\"name\":\"Waelchi Inc\"},\"title\":\"Mr. Jonathon Upton\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3967,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.528409Z\",\"ends_at\":\"2026-05-21T15:37:59.528506Z\",\"stats\":[]}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create Return Ad", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads", "query": [], "raw": "{{baseUrl}}\/v2\/return-ads" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"qekib\",\"advertiser_group_id\":7,\"advertiser_id\":13,\"return_link\":\"https:\\\/\\\/advertiser.com\",\"display_for_all_advertisers\":true,\"advertiser_ids\":[15],\"advertiser_category_ids\":[14],\"styles\":{\"color\":\"#ffffff\"},\"image_key\":\"dG1wL2ltYWdlLmpwZw==\",\"starts_at\":\"2026-04-21T17:37:59\",\"ends_at\":\"2065-01-17\",\"click_limit\":3,\"view_limit\":3}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"name\":\"Drake Kautzer\",\"advertiser_group_id\":4943,\"affiliate_link\":{\"id\":885,\"url\":\"http:\\\/\\\/www.kirlin.com\\\/\",\"original_url\":\"http:\\\/\\\/www.bosco.com\\\/maxime-blanditiis-quae-earum-hic-consequuntur-perspiciatis-in.html\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/885\",\"user_id\":3968,\"country\":\"SH\",\"provider\":\"navy\",\"advertiser\":{\"id\":2289,\"name\":\"McGlynn, Paucek and Upton\"},\"title\":\"Casey Robel II\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3969,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.571953Z\",\"ends_at\":\"2026-05-21T15:37:59.572021Z\",\"stats\":[]}", "name": "" } ] }, { "name": "Get Return Ad", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/return-ads\/:id", "variable": [ { "id": "id", "key": "id", "value": "7", "description": "The ID of the return ad." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"name\":\"Dr. Quinten Block IV\",\"advertiser_group_id\":4946,\"affiliate_link\":{\"id\":886,\"url\":\"http:\\\/\\\/www.okon.biz\\\/est-non-corporis-nam-distinctio\",\"original_url\":\"http:\\\/\\\/www.boehm.com\\\/sint-itaque-quas-corrupti-omnis.html\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/886\",\"user_id\":3970,\"country\":\"SS\",\"provider\":\"black\",\"advertiser\":{\"id\":2290,\"name\":\"Kshlerin-Swaniawski\"},\"title\":\"Mr. Lorenzo Adams DVM\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3971,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.606683Z\",\"ends_at\":\"2026-05-21T15:37:59.606749Z\",\"stats\":[]}", "name": "" } ] }, { "name": "Update Return Ad", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/return-ads\/:id", "variable": [ { "id": "id", "key": "id", "value": "8", "description": "The ID of the return ad." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"jyacddbnbvawb\",\"return_link\":\"https:\\\/\\\/advertiser.com\",\"display_for_all_advertisers\":true,\"advertiser_ids\":[8],\"advertiser_category_ids\":[7],\"styles\":{\"color\":\"#ffffff\"},\"image_key\":\"dG1wL2ltYWdlLmpwZw==\",\"starts_at\":\"2026-04-21T17:37:59\",\"ends_at\":\"2052-04-05\",\"click_limit\":18,\"view_limit\":15}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"name\":\"Issac White\",\"advertiser_group_id\":4949,\"affiliate_link\":{\"id\":887,\"url\":\"http:\\\/\\\/www.king.biz\\\/\",\"original_url\":\"http:\\\/\\\/bogan.biz\\\/\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/887\",\"user_id\":3972,\"country\":\"TV\",\"provider\":\"white\",\"advertiser\":{\"id\":2291,\"name\":\"Hegmann LLC\"},\"title\":\"Destinee Shanahan\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3973,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.653549Z\",\"ends_at\":\"2026-05-21T15:37:59.653636Z\",\"stats\":[]}", "name": "" } ] }, { "name": "Delete Return Ad", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/return-ads\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "The ID of the return ad." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Pause Return Ad", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads\/:returnAd_id\/pause", "query": [], "raw": "{{baseUrl}}\/v2\/return-ads\/:returnAd_id\/pause", "variable": [ { "id": "returnAd_id", "key": "returnAd_id", "value": "9", "description": "The ID of the returnAd." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deactivates Return Ad" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"name\":\"Mrs. Syble Crist II\",\"advertiser_group_id\":4952,\"affiliate_link\":{\"id\":888,\"url\":\"http:\\\/\\\/tromp.com\\\/tempore-ea-aspernatur-quia-quia-iusto-hic-placeat\",\"original_url\":\"http:\\\/\\\/www.collins.com\\\/fugiat-perspiciatis-consequatur-ut-voluptatibus-nostrum\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/888\",\"user_id\":3974,\"country\":\"CM\",\"provider\":\"maroon\",\"advertiser\":{\"id\":2292,\"name\":\"Johnson and Sons\"},\"title\":\"Miss Jada Grady\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3975,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.710549Z\",\"ends_at\":\"2026-05-21T15:37:59.710668Z\",\"stats\":[]}", "name": "" } ] }, { "name": "Unpause Return Ad", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/return-ads\/:returnAd_id\/unpause", "query": [], "raw": "{{baseUrl}}\/v2\/return-ads\/:returnAd_id\/unpause", "variable": [ { "id": "returnAd_id", "key": "returnAd_id", "value": "10", "description": "The ID of the returnAd." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"name\":\"America Stark\",\"advertiser_group_id\":4955,\"affiliate_link\":{\"id\":889,\"url\":\"http:\\\/\\\/www.bednar.com\\\/est-consectetur-ullam-occaecati-consequatur.html\",\"original_url\":\"http:\\\/\\\/breitenberg.net\\\/\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/889\",\"user_id\":3976,\"country\":\"ML\",\"provider\":\"gray\",\"advertiser\":{\"id\":2293,\"name\":\"Rath-Marvin\"},\"title\":\"Prof. Jonathon Conn\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3977,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.745740Z\",\"ends_at\":\"2026-05-21T15:37:59.745818Z\",\"stats\":[]}", "name": "" } ] }, { "name": "Get Return Ads for Advertiser", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/advertisers\/:store_id\/return-ads", "query": [], "raw": "{{baseUrl}}\/v2\/advertisers\/:store_id\/return-ads", "variable": [ { "id": "store_id", "key": "store_id", "value": "7", "description": "The ID of the store." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List of Return Ads displayed for Advertiser by ID" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":null,\"name\":\"Lizzie Stokes DDS\",\"advertiser_group_id\":4958,\"affiliate_link\":{\"id\":890,\"url\":\"http:\\\/\\\/wiegand.com\\\/\",\"original_url\":\"http:\\\/\\\/hintz.com\\\/consectetur-voluptas-possimus-qui-corrupti\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/890\",\"user_id\":3978,\"country\":\"SB\",\"provider\":\"fuchsia\",\"advertiser\":{\"id\":2294,\"name\":\"Krajcik LLC\"},\"title\":\"Delores Langosh\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3979,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.782368Z\",\"ends_at\":\"2026-05-21T15:37:59.782435Z\",\"stats\":[]},{\"id\":null,\"name\":\"Shyann Metz\",\"advertiser_group_id\":4961,\"affiliate_link\":{\"id\":891,\"url\":\"http:\\\/\\\/www.wolf.com\\\/molestiae-saepe-dignissimos-quasi-quod-consequatur-a-aut-autem.html\",\"original_url\":\"http:\\\/\\\/www.barrows.com\\\/totam-harum-non-maxime-atque-odit\",\"mtpc_url\":\"https:\\\/\\\/c.mtpc.se\\\/891\",\"user_id\":3980,\"country\":\"CD\",\"provider\":\"aqua\",\"advertiser\":{\"id\":2295,\"name\":\"Fadel-Bayer\"},\"title\":\"Miss Noemy Wiegand\",\"created_at\":\"2026-04-21T17:37:59+02:00\"},\"author_id\":3981,\"display_for_all_advertisers\":false,\"status\":\"active\",\"styles\":null,\"image\":null,\"starts_at\":\"2026-03-21T16:37:59.807732Z\",\"ends_at\":\"2026-05-21T15:37:59.807831Z\",\"stats\":[]}]", "name": "" } ] } ] }, { "name": "Shared Budget", "description": "", "item": [ { "name": "List Shared Budgets", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores\/:store_id\/shared-budgets", "query": [], "raw": "{{baseUrl}}\/v2\/stores\/:store_id\/shared-budgets", "variable": [ { "id": "store_id", "key": "store_id", "value": "2", "description": "The ID of the store." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List Shared Budgets for Store" }, "response": [ { "header": [], "code": 200, "body": "[{\"id\":null,\"title\":\"Josh O'Reilly\",\"amount\":9,\"amount_v2\":{\"amount\":\"0.09\",\"currency\":\"PLN\"},\"consumed_budget\":0,\"consumed_budget_v2\":{\"amount\":\"0\",\"currency\":\"PLN\"},\"currency\":\"PLN\"},{\"id\":null,\"title\":\"Lorna Hansen\",\"amount\":7,\"amount_v2\":{\"amount\":\"0.07\",\"currency\":\"PLN\"},\"consumed_budget\":0,\"consumed_budget_v2\":{\"amount\":\"0\",\"currency\":\"PLN\"},\"currency\":\"PLN\"}]", "name": "" } ] }, { "name": "Display Budget", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores\/:store_id\/shared-budgets\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/stores\/:store_id\/shared-budgets\/:id", "variable": [ { "id": "store_id", "key": "store_id", "value": "16", "description": "The ID of the store." }, { "id": "id", "key": "id", "value": "6", "description": "The ID of the shared budget." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns information about a specific budget." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"title\":\"Ibrahim Walker\",\"amount\":1,\"amount_v2\":{\"amount\":\"0.01\",\"currency\":\"SEK\"},\"consumed_budget\":0,\"consumed_budget_v2\":{\"amount\":\"0\",\"currency\":\"SEK\"},\"currency\":\"SEK\"}", "name": "" } ] }, { "name": "Update Shared Budget", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores\/:store_id\/shared-budgets\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/stores\/:store_id\/shared-budgets\/:id", "variable": [ { "id": "store_id", "key": "store_id", "value": "10", "description": "The ID of the store." }, { "id": "id", "key": "id", "value": "9", "description": "The ID of the shared budget." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Summer budget\",\"amount\":10000}" }, "description": "Updates existing budget." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":null,\"title\":\"Lisa Pacocha III\",\"amount\":4,\"amount_v2\":{\"amount\":\"0.04\",\"currency\":\"PLN\"},\"consumed_budget\":0,\"consumed_budget_v2\":{\"amount\":\"0\",\"currency\":\"PLN\"},\"currency\":\"PLN\"}", "name": "" } ] }, { "name": "Delete Shared Budget", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores\/:store_id\/shared-budgets\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/stores\/:store_id\/shared-budgets\/:id", "variable": [ { "id": "store_id", "key": "store_id", "value": "20", "description": "The ID of the store." }, { "id": "id", "key": "id", "value": "7", "description": "The ID of the shared budget." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Store", "description": "", "item": [ { "name": "PUT v2\/stores\/{advertiser}\/payment", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/stores\/:advertiser\/payment", "query": [], "raw": "{{baseUrl}}\/v2\/stores\/:advertiser\/payment", "variable": [ { "id": "advertiser", "key": "advertiser", "value": "10", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payment_setup_id\":\"qui\"}" }, "description": "" }, "response": [] } ] }, { "name": "Uploads", "description": "", "item": [ { "name": "Upload image", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/image-uploads", "query": [], "raw": "{{baseUrl}}\/v2\/image-uploads" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"image\":\"velit\"}" }, "description": "Uploads an image to tmp folder." }, "response": [] } ] }, { "name": "User", "description": "", "item": [ { "name": "List users", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users", "query": [ { "key": "query", "value": "testcreator123", "description": "Query by either of the following: ID, username, email.\n Returns all users with id equal to `query` OR username contains `query` OR email contains `query`. Must not be greater than 64 characters.", "disabled": false }, { "key": "client_id", "value": "2", "description": "Query by user's client. Returns all users which belong to the given `client_id`.", "disabled": false }, { "key": "store_group_id", "value": "15", "description": "Query by user's store group. Returns all users which belong to the given `store_group_id`.", "disabled": false }, { "key": "advertiser_id", "value": "123", "description": "Filter users by advertiser\/store id. Required for non-admin advertiser users. Admins can pass it optionally. The id of an existing record in the stores table.", "disabled": false }, { "key": "include[0]", "value": "email", "description": "", "disabled": false }, { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 100.", "disabled": false }, { "key": "sort_by", "value": "doloremque", "description": "Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false }, { "key": "status", "value": "accepted", "description": "User status (accepted, suspended, undecided). When omitted, suspended users are excluded.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/users?query=testcreator123&client_id=2&store_group_id=15&advertiser_id=123&include[0]=email&size=20&sort_by=doloremque&status=accepted" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying & sorting all users." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":14,\"username\":\"emerald.von\",\"display_name\":\"Marisa Turcotte\",\"email\":\"slabadie@example.com\",\"client_id\":16,\"preferred_locale\":\"vi_VN\",\"language\":\"vi\"},{\"id\":14,\"username\":\"emerald.von\",\"display_name\":\"Marisa Turcotte\",\"email\":\"slabadie@example.com\",\"client_id\":16,\"preferred_locale\":\"vi_VN\",\"language\":\"vi\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get User Details", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:id", "query": [], "raw": "{{baseUrl}}\/v2\/users\/:id", "variable": [ { "id": "id", "key": "id", "value": "14", "description": "The ID of the user." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"id\":14,\"username\":\"emerald.von\",\"display_name\":\"Marisa Turcotte\",\"email\":\"slabadie@example.com\",\"client_id\":16,\"preferred_locale\":\"vi_VN\",\"language\":\"vi\"}", "name": "" } ] }, { "name": "Create Creator User", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users", "query": [], "raw": "{{baseUrl}}\/v2\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"social_media\":[{\"type\":\"instagram\",\"identifier\":\"https:\\\/\\\/instagram.com\\\/example\"},{\"type\":\"tiktok\",\"identifier\":\"https:\\\/\\\/tiktok.com\\\/@example\"}],\"utm\":{\"source\":\"instagram\",\"medium\":\"social\",\"campaign\":\"launch2025\",\"term\":\"influencer\",\"content\":\"story_ad\"},\"client_id\":\"client_12345\",\"preferred_locale\":\"en-GB\"}" }, "description": "Requires an Ory-issued JWT for a session not yet linked to a Metapic user (no user_id)." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":14,\"username\":\"emerald.von\",\"display_name\":\"Marisa Turcotte\",\"email\":\"slabadie@example.com\",\"client_id\":16,\"preferred_locale\":\"vi_VN\",\"language\":\"vi\"}", "name": "" }, { "header": [], "code": 409, "body": null, "name": "User with this email already exists" } ] }, { "name": "Update User Identity", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/users\/:user_id\/identity", "query": [], "raw": "{{baseUrl}}\/v2\/users\/:user_id\/identity", "variable": [ { "id": "user_id", "key": "user_id", "value": "14", "description": "The ID of the user." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"user@example.com\",\"phone\":\"+1234567890\"}" }, "description": "It updates user's email and phone and syncs it with Ory identity." }, "response": [] }, { "name": "Match users by IDs and emails", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/match-users", "query": [ { "key": "advertiser_group_id", "value": "15", "description": "Query by user's advertiser group. Returns all users which belong to the given `advertiser_group_id`.", "disabled": false }, { "key": "user_emails_or_ids[0]", "value": "12345", "description": "a mix array of user emails and ids. Must not have more than 1000 items.", "disabled": false }, { "key": "user_emails_or_ids[1]", "value": "email@metapic.com", "description": "a mix array of user emails and ids. Must not have more than 1000 items.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/match-users?advertiser_group_id=15&user_emails_or_ids[0]=12345&user_emails_or_ids[1]=email@metapic.com" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Approve users", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/approve-users", "query": [], "raw": "{{baseUrl}}\/v2\/approve-users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_ids\":[5]}" }, "description": "Approves multiple users at once. When approving a banned user, it cleans up the banned_at (suspended_at) property and sets the approved_at (verified_at).\nEvents are triggered only for users whose status actually changes." }, "response": [] }, { "name": "Ban users", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/ban-users", "query": [], "raw": "{{baseUrl}}\/v2\/ban-users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_ids\":[1]}" }, "description": "Bans multiple users at once. The ban action also deletes all user offers.\nEvents are triggered only for users whose status actually changes." }, "response": [] } ] }, { "name": "User Tag", "description": "", "item": [ { "name": "List user tags", "request": { "url": { "host": "{{baseUrl}}", "path": "v2\/user-tags", "query": [ { "key": "name", "value": "favourites", "description": "Query by user tag's name. Returns all user tags whose name contains the given `name`. Must not be greater than 255 characters.", "disabled": false }, { "key": "store_id", "value": "15", "description": "Query by user tag's store. Returns all user tags which belong to the given `store_id`.", "disabled": false }, { "key": "access_levels[0]", "value": "0", "description": "Query by user tag's access levels. Returns all user tags which have the given `access_levels`:\n \n ACCESS_LEVEL_ADMIN = 0\n ACCESS_LEVEL_ALL = 1\n ACCESS_LEVEL_STORE = 2\n .", "disabled": false }, { "key": "access_levels[1]", "value": "1", "description": "Query by user tag's access levels. Returns all user tags which have the given `access_levels`:\n \n ACCESS_LEVEL_ADMIN = 0\n ACCESS_LEVEL_ALL = 1\n ACCESS_LEVEL_STORE = 2\n .", "disabled": false }, { "key": "size", "value": "20", "description": "Page size. Defaults to 20. Must not be greater than 100.", "disabled": false }, { "key": "sort_by", "value": "quo", "description": "Must follow the correct format: `column_name:direction`,\n where `column_name` must be a valid property for given resource and `direction` can be one of `asc|desc`,\n both of which are required if `sort_by` is present.", "disabled": false } ], "raw": "{{baseUrl}}\/v2\/user-tags?name=favourites&store_id=15&access_levels[0]=0&access_levels[1]=1&size=20&sort_by=quo" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Endpoint for querying & sorting all user tags." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":null,\"name\":\"Bo Nienow Jr.\",\"slug\":\"sequi-ea-fugiat\",\"access_level\":1,\"store_id\":2298},{\"id\":null,\"name\":\"Vince Paucek V\",\"slug\":\"qui-laudantium\",\"access_level\":1,\"store_id\":2299}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":20,\"to\":2,\"total\":2}}", "name": "" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "in", "value": "header", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] } }