This documentation aims to provide all the information you need to work with our API. The v2 (and above) API follows the Design Principles and Guidelines. If you find anything that doesn't comply, please complain to the dev team immediately 👮
To authenticate requests, include a Authorization
header with the value "{accessToken}"
.
All authenticated endpoints are marked with a requires authentication
badge in the documentation below.
For more information see Authentication in the P&E docs.
Manages the creator blocklist for an advertiser.
Creators added to the blocklist will not see the advertiser nor be able to convert links for that advertiser.
The ID of the advertiser.
Filters results to match user ID or username. Must not be greater than 128 characters.
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/17/blocklist?query=hciptdpmqmpbccbxc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 81,
"created_at": "2025-10-23 14:07:50",
"created_by": {
"id": 3651,
"username": "unique60",
"display_name": "Derek Kuhic",
"email": "[email protected]",
"client_id": 3831
},
"client": {
"id": 3832,
"name": "Celine Jerde",
"client_id": "XBLU1GSTGF",
"has_own_payment_system": false,
"revenue_share": 1
}
},
{
"id": 82,
"created_at": "2025-10-23 14:07:50",
"created_by": {
"id": 3652,
"username": "reynold16",
"display_name": "Chloe Gutmann",
"email": "[email protected]",
"client_id": 3833
},
"client": {
"id": 3834,
"name": "Leif Jacobi",
"client_id": "OkDXc2GClE",
"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
}
}
Adds the given entries to the blocklist, ignoring them if they previously existed.
The ID of the advertiser.
curl --request POST \
"https://api.metapic.dev/v2/advertisers/13/blocklist" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"users\": [
{
\"id\": 123,
\"validate_clicks\": true
},
{
\"id\": 456,
\"validate_clicks\": false
}
],
\"user_tag_ids\": [
10
],
\"client_ids\": [
20
]
}"
The ID of the advertiser.
The ID of the target.
curl --request DELETE \
"https://api.metapic.dev/v2/advertisers/4/blocklist/18" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Returns the settings to be added to the sales pixel script.
The advertiser.
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/eius/order-collectors/sales-pixel" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Returns the tracking configuration for the advertiser.
The advertiser.
The identifier of the collector
woocommerce
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/et/order-collectors/woocommerce" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Activates the tracking plugin with the given activation key.
Returns the parameters to insert into the Javascript tracking snippet.
curl --request POST \
"https://api.metapic.dev/v2/activate-tracking-plugin" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"metapic_activation_key\": \"perspiciatis\"
}"
Returns remaining email quota for the advertiser.
The ID of the advertiser.
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/4/email-quota" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Endpoint for querying & sorting all stores.
Query by either of the following: ID, store name.
Returns all stores with id equal to query
OR name contains query
. Must not be greater than 255 characters.
Query by store's store group. Returns all stores which belong to the given store_group_id
.
Page size. Defaults to 20. Must not be greater than 100.
Must follow the correct format: column_name:direction
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
curl --request GET \
--get "https://api.metapic.dev/v2/stores?query=nike&store_group_id=15&size=20&sort_by=eaque" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 2221,
"name": "Spencer, Kunze and Howe"
},
{
"id": 2222,
"name": "Swift-Boehm"
}
],
"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
}
}
Manages url matching rules for an advertiser. Url Matching rule can either be to allow or to block matching of a URL based on added rules.
Returns all url matching rules defined for the advertiser.
The ID of the advertiser.
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/14/url-matching-rules" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 293,
"type": "allow",
"is_main": false,
"url": "testcompany.com",
"updated_at": "2025-10-23T14:07:50.000000Z"
},
{
"id": 294,
"type": "allow",
"is_main": false,
"url": "testcompany.com",
"updated_at": "2025-10-23T14:07:50.000000Z"
}
]
Adds a new rule to the url matching for the advertiser.
The ID of the advertiser.
curl --request POST \
"https://api.metapic.dev/v2/advertisers/2/url-matching-rules" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"block\",
\"url\": \"http:\\/\\/abshire.com\\/doloremque-aliquid-quibusdam-excepturi\",
\"keyword\": \"iecialclxyzlqvwqdstip\",
\"is_main\": true
}"
Updates existing url matching rule for the advertiser.
The ID of the advertiser.
The ID of the urlMatchingRule.
curl --request PUT \
"https://api.metapic.dev/v2/advertisers/15/url-matching-rules/12" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"type\": \"allow\",
\"url\": \"http:\\/\\/www.gleason.com\\/facere-cumque-sunt-tempora\",
\"keyword\": \"bwzeofij\",
\"is_main\": true
}"
Removes existing url matching rule for the advertiser.
The ID of the advertiser.
The ID of the urlMatchingRule.
curl --request DELETE \
"https://api.metapic.dev/v2/advertisers/11/url-matching-rules/4" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request POST \
"https://api.metapic.dev/v2/stores" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"My Store\",
\"domains\": [
[
\"dev.test-test.com\"
]
],
\"categories\": [
20
],
\"logo_url\": \"http:\\/\\/www.kub.org\\/qui-maiores-necessitatibus-enim-ut.html\",
\"country\": \" Example: SE\",
\"currency\": \"Example: EUR\",
\"language\": \"sv\",
\"billing\": {
\"company_name\": \"similique\",
\"street\": \"ratione\",
\"postal_code\": \"numquam\",
\"city\": \"ab\",
\"vat_number\": \"cumque\"
}
}"
{
"id": 2223,
"name": "Anderson-Adams"
}
Deactivates the advertiser.
The ID of the advertiser.
curl --request POST \
"https://api.metapic.dev/v2/advertisers/15/deactivate" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
App\Http\Resources\Store\StoreResource
Endpoint for querying & sorting all advertiser groups.
Only return advertiser groups which have return ads enabled.
Page size. Defaults to 20. Must not be greater than 100.
Must follow the correct format: column_name:direction
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
curl --request GET \
--get "https://api.metapic.dev/v2/advertiser-groups?return_ad_enabled=&size=20&sort_by=debitis" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 4579,
"name": "Braun PLC",
"key": "se_FI",
"currency": "SEK"
},
{
"id": 4580,
"name": "Padberg-Barrows",
"key": "id_ID",
"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
}
}
The ID of the affiliate link.
curl --request GET \
--get "https://api.metapic.dev/v2/affiliate-links/soluta" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 852,
"url": "http://www.swaniawski.info/ipsam-quasi-amet-quos-reprehenderit-illo-aut.html",
"original_url": "http://huels.com/voluptas-eum-distinctio-numquam-et-doloremque-suscipit-accusantium-quam.html",
"mtpc_url": "https://c.mtpc.se/852",
"user_id": 3656,
"country": "IT",
"provider": "fuchsia",
"advertiser": {
"id": 2226,
"name": "Beahan-Hayes"
}
}
Returns advertisers if there are multiple advertisers to match the url with. Otherwise, returns the affiliate link.
curl --request POST \
"https://api.metapic.dev/v2/affiliate-links" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"url\": \"https:\\/\\/advertiser.com\",
\"advertiser_id\": 16,
\"advertiser_preview\": true,
\"advertiser_group_id\": 1,
\"dry\": true
}"
{
"status": "success",
"affiliate_link": {
"status": "success",
"id": 853,
"url": "http://jacobs.info/alias-dolor-dolores-expedita-odio-dignissimos-eligendi",
"original_url": "http://www.bernhard.com/dolorem-et-cumque-rerum",
"mtpc_url": "https://c.mtpc.se/853",
"user_id": 3657,
"country": "TN",
"provider": "teal",
"advertiser": {
"id": 2227,
"name": "Flatley, Von and Hickle"
}
}
}
Returns advertisers if there are multiple advertisers to match the url with. Otherwise, returns the affiliate link.
The ID of the user.
curl --request POST \
"https://api.metapic.dev/v2/users/11/affiliate-links" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"url\": \"https:\\/\\/advertiser.com\",
\"advertiser_id\": 2,
\"advertiser_preview\": true,
\"advertiser_group_id\": 1,
\"dry\": true
}"
{
"status": "success",
"affiliate_link": {
"status": "success",
"id": 854,
"url": "http://www.rutherford.net/",
"original_url": "http://www.nitzsche.com/molestias-ad-veniam-reiciendis-aperiam-reiciendis",
"mtpc_url": "https://c.mtpc.se/854",
"user_id": 3658,
"country": "CU",
"provider": "silver",
"advertiser": {
"id": 2228,
"name": "Pfeffer, Wintheiser and Sanford"
}
}
}
Endpoint for querying & sorting all clients.
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.
Query by advertiser group. Returns all clients which belong to the given advertiser_group_ids
.
Page size. Defaults to 20. Must not be greater than 500.
Must follow the correct format: column_name:direction
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
curl --request GET \
--get "https://api.metapic.dev/v2/clients?query=internal+name&advertiser_group_ids[]=1&size=20&sort_by=corrupti" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 3835,
"name": "Osbaldo Carter",
"client_id": "qNbo0dAzJn",
"has_own_payment_system": false,
"revenue_share": 1
},
{
"id": 3836,
"name": "Helene Corkery",
"client_id": "9WEMQxcn6M",
"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
}
}
Operations on Media posted by Creators
Filters media by username.
Filter user media by show store value.
all
0
1
2
Filters media by type.
all
instagram
tiktok
youtube
Filter user media by favorite value.
all
1
0
:shrug:.
Format to export.
csv
xlsx
json
curl --request GET \
--get "https://api.metapic.dev/v2/user-media?query=sit&status=2&type=instagram&favorite=0&group=15&format=csv" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"current_page": 1,
"data": [
{
"id": 1,
"media_type": "youtube",
"media_id": "FLR0BB4qDt8",
"username": "hamida_most",
"tag_id": null,
"user_id": null,
"favorite": 1,
"show_store": 1,
"published_at": "2023-05-13",
"created_at": "2023-07-18T12:02:53.000000Z",
"updated_at": "2023-07-18T12:09:13.000000Z"
},
{
"id": 2,
"media_type": "tiktok",
"username": "juliaringblomm",
"tag_id": null,
"user_id": null,
"favorite": 1,
"show_store": 0,
"published_at": "2023-06-17",
"created_at": "2023-07-18T12:10:49.000000Z",
"updated_at": "2023-07-18T13:39:28.000000Z",
"media": {
"content_type": "video/mp4",
"href": "https://metapic-tiktok-media.example/juliaringblomm/7245692137566653722"
}
},
{
"id": 3,
"media_type": "instagram",
"username": "juliaringblomm",
"tag_id": null,
"user_id": null,
"favorite": 1,
"show_store": 0,
"published_at": "2023-06-17",
"created_at": "2023-07-18T12:10:49.000000Z",
"updated_at": "2023-07-18T13:39:28.000000Z",
"media": {
"content_type": "video/mp4",
"href": "https://metapic-instragram-media.example/juliaringblomm/7245692137566653722"
}
},
{
"id": 4,
"media_type": "instagram",
"username": "juliaringblomm",
"tag_id": null,
"user_id": null,
"favorite": 1,
"show_store": 0,
"published_at": "2023-06-17",
"created_at": "2023-07-18T12:10:49.000000Z",
"updated_at": "2023-07-18T13:39:28.000000Z",
"media": {
"content_type": "image/jpeg",
"href": "https://metapic-instragram-media.example/juliaringblomm/7245692137566653722"
}
}
],
"first_page_url": "http://metapic-api.my/user-media?page=1",
"from": 1,
"last_page": 3,
"last_page_url": "http://metapic-api.my/user-media?page=3",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://metapic-api.my/user-media?page=1",
"label": "1",
"active": true
},
{
"url": "http://metapic-api.my/user-media?page=2",
"label": "2",
"active": false
},
{
"url": "http://metapic-api.my/user-media?page=3",
"label": "3",
"active": false
},
{
"url": "http://metapic-api.my/user-media?page=2",
"label": "Next »",
"active": false
}
],
"next_page_url": "http://metapic-api.my/user-media?page=2",
"path": "http://metapic-api.my/user-media",
"per_page": 5,
"prev_page_url": null,
"to": 5,
"total": 12
}
curl --request GET \
--get "https://api.metapic.dev/v2/health" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"status": "up"
}
curl --request GET \
--get "https://api.metapic.dev/v2/store-categories" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 67,
"name": "Beauty"
},
{
"id": 68,
"name": "Fashion"
}
]
curl --request GET \
--get "https://api.metapic.dev/v2/payments/getPaymentInvoices" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payment_period\": \"2025-10\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/users/13/stores-by-categories" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/users/6/stores-by-toplist" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
curl --request POST \
"https://api.metapic.dev/v2/payments/upload-ax-id-matching" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"file\": \"itanqfxevrotsxwyi\"
}"
curl --request POST \
"https://api.metapic.dev/v2/payments/mark-invoices-as-paid" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"file\": \"zgzbtlkpcivwnd\"
}"
Endpoint for generating a creator invoice from external component
curl --request POST \
"https://api.metapic.dev/v2/payments/generate-creator-invoice/rerum" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Endpoint for querying the current payment systems configuration
The payment date. Example: 2021-01-11. Must be a valid date.
Filter by client ID. The id
of an existing record in the clients table.
Filter by user ID. The id
of an existing record in the users table.
curl --request GET \
--get "https://api.metapic.dev/v2/payments/systems-config?date=2021-01-11&client_id=2&user_id=15" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Endpoint for updating the current payment systems configuration
curl --request POST \
"https://api.metapic.dev/v2/payments/systems-config" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"date\": \"2025-10-23T16:07:50\",
\"client_id\": 15,
\"user_id\": 14,
\"system\": \"2\",
\"ignore_lock\": true
}"
curl --request GET \
--get "https://api.metapic.dev/v2/entrypoint" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"app\": \"creator\",
\"store_id\": 8
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
curl --request GET \
--get "https://api.metapic.dev/v2/notifications-proxy/Z*"" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Creates new campaign for a store.
The store ID.
curl --request POST \
"https://api.metapic.dev/v2/stores/15/offers" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"store_group_id\": 13,
\"type\": \"store_accept\",
\"name\": \"Summer campaign for VIP creators\",
\"campaign_title\": \"Summer campaign\",
\"campaign_text\": \"This is a summer campaign!\",
\"has_product_seeding\": true,
\"has_onetime_payment\": true,
\"per_user_limit\": false,
\"one_time_payment\": 5,
\"budget_limit\": 12,
\"max_clicks\": 18,
\"valid_from\": \"2025-10-23T16:07:46\",
\"valid_until\": \"2065-11-12\",
\"todo\": [
\"wuayquycbulca\"
],
\"show_for_advertiser\": false,
\"priority_after\": 16,
\"shared_budget_id\": 1,
\"shared_budget\": {
\"title\": \"Summer budget\",
\"amount\": 10000
},
\"targets\": {
\"user_ids\": [
3
],
\"user_tag_ids\": [
2
],
\"store_group_ids\": [
5
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"idvxknibfuoucv\"
],
\"client_ids\": [
8
],
\"revenue_tier_ids\": [
4
]
},
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": 230,
\"cpa\": 0.2,
\"invoice_cpc\": 250,
\"invoice_cpa\": 0.25,
\"user_revenue\": 0
}
]
}"
{
"data": {
"id": 746,
"campaign_title": "Dee Roberts",
"campaign_text": "Illo architecto sint fuga laudantium. Voluptatibus laborum et hic voluptatem in laborum voluptatem.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjc3P3RleHQ9YmxhbmRpdGlpcw==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjc3P3RleHQ9YmxhbmRpdGlpcw==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjc3P3RleHQ9YmxhbmRpdGlpcw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjc3P3RleHQ9YmxhbmRpdGlpcw=="
},
"store_id": 2185,
"store_name": "Mann and Sons",
"store_logo_url": null,
"store_logo": null,
"currency": "SEK",
"token": "hiaxxyohpnzkmfe5",
"type": "standard",
"warnings": {
"skipped_targets": {
"user_ids": [
12,
15
]
}
}
},
"warnings": {
"skipped_targets": {
"user_ids": [
12,
15
]
}
}
}
Returns information about a specific campaign.
The offer ID
curl --request GET \
--get "https://api.metapic.dev/v2/offers/15556" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 747,
"campaign_title": "Prof. Janie Gerhold PhD",
"campaign_text": "Aliquid earum quos assumenda rerum molestiae. Ab deserunt velit rerum odit consequatur est consequatur. Aperiam magni id illum neque nam sed. Unde voluptatem incidunt soluta consequatur aut corrupti.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMDU1P3RleHQ9bWluaW1h",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMDU1P3RleHQ9bWluaW1h",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMDU1P3RleHQ9bWluaW1h",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMDU1P3RleHQ9bWluaW1h"
},
"store_id": 2186,
"store_name": "Kihn Inc",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "etctywz6zptaenmp",
"traffic_sources_costs": [
{
"id": 219,
"source": 1,
"source_name": "Instagram",
"cpc": null,
"cpa": null,
"currency": "PLN"
}
],
"type": "standard"
}
Updates existing campaign.
The ID of the offer.
The offer ID
curl --request PUT \
"https://api.metapic.dev/v2/offers/20" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"store_group_id\": 3,
\"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\": false,
\"per_user_limit\": true,
\"one_time_payment\": 1.95,
\"budget_limit\": 7,
\"max_clicks\": 14,
\"valid_from\": \"2025-10-23T16:07:47\",
\"valid_until\": \"1994-03-21\",
\"todo\": [
\"lx\"
],
\"show_for_advertiser\": true,
\"priority_after\": 7,
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": 230,
\"cpa\": 0.2,
\"invoice_cpc\": 250,
\"invoice_cpa\": 0.25,
\"user_revenue\": 0
}
],
\"targets\": {
\"0\": [],
\"user_ids\": [
1
],
\"user_tag_ids\": [
14
],
\"store_group_ids\": [
9
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"piloeztqickcnfqvpkljjktd\"
],
\"client_ids\": [
3
],
\"revenue_tier_ids\": [
17
]
},
\"shared_budget_id\": 1,
\"shared_budget\": {
\"title\": \"Summer budget\",
\"amount\": 10000
}
}"
{
"data": {
"id": 748,
"campaign_title": "Dustin Batz",
"campaign_text": "Qui est consequatur id eum explicabo. Sed accusamus sed ipsum ut est nesciunt vel. Vero provident aut et velit nulla enim.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmVlP3RleHQ9ZWE=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmVlP3RleHQ9ZWE=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmVlP3RleHQ9ZWE=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmVlP3RleHQ9ZWE="
},
"store_id": 2187,
"store_name": "Graham Group",
"store_logo_url": null,
"store_logo": null,
"currency": "GBP",
"token": "9mzha7q044ns2bdo",
"type": "standard",
"warnings": {
"skipped_targets": {
"user_ids": [
12,
15
]
}
}
},
"warnings": {
"skipped_targets": {
"user_ids": [
12,
15
]
}
}
}
Soft deletes a campaign.
The ID of the offer.
The offer ID
curl --request DELETE \
"https://api.metapic.dev/v2/offers/16" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Endpoint for querying & sorting all campaigns.
Query by either of the following: ID, internal name, title.
Returns all offers with id equal to query
OR name contains query
OR campaign_title contains query
. Must not be greater than 64 characters.
deleted
ended
scheduled
paused
active
Query by offer's store. Returns all offers which belong to the given store_ids
.
Query by offer's store group. Returns all offers which belong to the given store_group_ids
.
Query by offer's author ID. Returns all offers created by the user making the request
Query by offer's ID. Performs an 'OR' search, compared to 'AND' search for other filters, so an offer with given ID is always included in the results, if matched.
Page size. Defaults to 20. Must not be greater than 100.
Must follow the correct format: column_name:direction
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
ends_soon
csv
xlsx
Admin-only filter offers by visibility on the advertiser.
Filter offers by advertiser. Required when filtering as non-admin.
curl --request GET \
--get "https://api.metapic.dev/v2/offers?query=black+friday&statuses[]=scheduled&store_ids[]=1&store_group_ids[]=1&created_by=20&or_id=1234&target_user_id=11&size=20&sort_by=blanditiis&custom_sort_by=ends_soon&format=xlsx&show_for_advertiser=&advertiser_id=123" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 749,
"campaign_title": "Mr. Rigoberto Skiles",
"campaign_text": "Quis veritatis modi aut est. In sit et quis. Quibusdam facere non mollitia totam enim.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzc3P3RleHQ9YWRpcGlzY2k=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzc3P3RleHQ9YWRpcGlzY2k=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzc3P3RleHQ9YWRpcGlzY2k=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzc3P3RleHQ9YWRpcGlzY2k="
},
"store_id": 2188,
"store_name": "Mann, Weimann and Schuster",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "pn4o5kmkvh26xeff",
"type": "standard"
},
{
"id": 750,
"campaign_title": "Jovanny Cummerata III",
"campaign_text": "Iusto sunt harum officiis et dignissimos. Necessitatibus porro numquam quis iste sed sed voluptas aliquam. Rerum consequatur atque qui quaerat.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NTY2P3RleHQ9ZW9z",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NTY2P3RleHQ9ZW9z",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NTY2P3RleHQ9ZW9z",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NTY2P3RleHQ9ZW9z"
},
"store_id": 2189,
"store_name": "Jast-Shanahan",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "84yus4hj71t64e9h",
"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
}
}
Uploads an image to a campaign.
The offer ID
curl --request POST \
"https://api.metapic.dev/v2/offers/15556/uploads" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"default\": \"possimus\"
}"
{
"id": 751,
"campaign_title": "Laverne Schuster DDS",
"campaign_text": "Quam recusandae placeat dolorem doloribus unde. Et eos molestiae qui ea vel temporibus. Occaecati quo occaecati et reiciendis aspernatur. Autem mollitia officia omnis voluptatem optio et.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9bW9kaQ==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9bW9kaQ==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9bW9kaQ==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9bW9kaQ=="
},
"store_id": 2190,
"store_name": "Trantow Group",
"store_logo_url": null,
"store_logo": null,
"currency": "GBP",
"token": "gk6gr8cuuzvryodw",
"type": "standard"
}
The offer ID
curl --request POST \
"https://api.metapic.dev/v2/offers/15556/pause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 752,
"campaign_title": "Alena Haley IV",
"campaign_text": "Non aut nihil voluptatibus voluptatem. Quia vel rerum adipisci ullam. Pariatur nihil animi magni sed.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9ZXQ=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9ZXQ=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9ZXQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9ZXQ="
},
"store_id": 2191,
"store_name": "Ankunding, Rolfson and Cronin",
"store_logo_url": null,
"store_logo": null,
"currency": "SEK",
"token": "wou45if4b09u59pd",
"type": "standard"
}
The offer ID
curl --request POST \
"https://api.metapic.dev/v2/offers/15556/unpause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 753,
"campaign_title": "Rodrick Ullrich",
"campaign_text": "Reiciendis voluptas saepe unde consequatur. Hic vel sed similique quae non.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTExP3RleHQ9Y29uc2VxdWF0dXI=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTExP3RleHQ9Y29uc2VxdWF0dXI=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTExP3RleHQ9Y29uc2VxdWF0dXI=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTExP3RleHQ9Y29uc2VxdWF0dXI="
},
"store_id": 2192,
"store_name": "Weissnat Ltd",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "qybwkisq6ervftha",
"type": "standard"
}
Returns statistics about a specific campaign.
The offer ID
The start date for the stats period (YYYY-MM-DD)
The end date for the stats period (YYYY-MM-DD)
curl --request GET \
--get "https://api.metapic.dev/v2/offers/15556/stats?start_date=2023-01-01&end_date=2023-01-31" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start_date\": \"2006-05-11\",
\"end_date\": \"2118-04-04\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/users/2/offers" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"open\",
\"name\": \"lwtvjhana\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Returns information about a specific campaign.
The offer ID
curl --request GET \
--get "https://api.metapic.dev/v2/offer-by-token/in" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 766,
"campaign_title": "Abbigail Huel",
"campaign_text": "Ratione assumenda ea voluptas exercitationem deleniti. Vero molestiae doloribus iusto. Temporibus et laborum sit non omnis. Quas vitae facere sint aut. Ut voluptas commodi ipsum facilis voluptas.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWFhP3RleHQ9aWxsdW0=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWFhP3RleHQ9aWxsdW0=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWFhP3RleHQ9aWxsdW0=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWFhP3RleHQ9aWxsdW0="
},
"store_id": 2229,
"store_name": "McLaughlin, Rath and Bins",
"store_logo_url": null,
"store_logo": null,
"currency": "EUR",
"token": "t10ue4guak8pq9j7",
"traffic_sources_costs": [
{
"id": 220,
"source": 0,
"source_name": "General",
"cpc": null,
"cpa": null,
"currency": "EUR"
}
],
"type": "standard"
}
The offer ID
curl --request GET \
--get "https://api.metapic.dev/v2/offers/15556/targets" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
The offer ID
curl --request POST \
"https://api.metapic.dev/v2/offers/15556/targets" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"user_ids\": [
2
],
\"user_tag_ids\": [
5
],
\"store_group_ids\": [
18
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"hh\"
],
\"client_ids\": [
20
],
\"revenue_tier_ids\": [
10
]
}"
The ID of the offer.
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/14/users/7" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
The ID of the offer.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/6/participants" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"query\": \"tyrk\",
\"status\": \"store_denied\",
\"include\": [
\"offer_comments_count\"
]
}"
{
"data": [
{
"id": null,
"offer_id": 755,
"user_id": 3619,
"display_name": null,
"clicks": 98180469,
"status": "product_sent",
"todo": null,
"payment_amount": null
},
{
"id": null,
"offer_id": 757,
"user_id": null,
"display_name": "dickens.kameron",
"clicks": 2,
"status": "accepted",
"pre_registered_identifier": "dickens.kameron",
"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
}
}
The ID of the offer.
The ID of the participant.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/9/participants/3" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": null,
"offer_id": 758,
"user_id": 3624,
"display_name": "homenick.jesse",
"clicks": 38259,
"status": "open",
"todo": null,
"payment_amount": null,
"social_media": [],
"tags": [
{
"id": 2151,
"name": "Zack Kling II",
"slug": "sed-aut-nihil",
"access_level": 1,
"store_id": 2198
}
]
}
The ID of the offer.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/12/participants-stats" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"query\": \"fcitijmdfcvzdwehqqjtunsks\",
\"active\": false,
\"start_date\": \"2020-11-07\",
\"end_date\": \"2095-11-10\",
\"sort_by\": \"estimated_gp:desc\"
}"
{
"data": [
{
"id": null,
"user_id": null,
"display_name": "pansy38",
"clicks": 0,
"status": "product_sent",
"links_created": null,
"estimated_gp": null,
"estimated_earning_to_cost_ratio": null
},
{
"id": null,
"user_id": null,
"display_name": "[email protected]",
"clicks": 0,
"status": "denied",
"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
}
}
The ID of the offer.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/14/participants-count-by-click-activity" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start_date\": \"2021-07-11\",
\"end_date\": \"2083-04-21\"
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
The ID of the offer.
The ID of the participant.
curl --request PATCH \
"https://api.metapic.dev/v2/offers/3/participants/4/update-status" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"suggestion\"
}"
{
"id": null,
"offer_id": 761,
"user_id": null,
"display_name": "[email protected]",
"clicks": 7,
"status": "have_received",
"pre_registered_email": "[email protected]",
"todo": null,
"payment_amount": null
}
The ID of the offer.
The ID of the participant.
curl --request PATCH \
"https://api.metapic.dev/v2/offers/16/participants/5/todo" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"todo\": [
{
\"key\": \"mdxbtijrgvlyacezb\",
\"value\": true
}
]
}"
{
"id": null,
"offer_id": 762,
"user_id": null,
"display_name": "[email protected]",
"clicks": 356010922,
"status": "product_sent",
"pre_registered_email": "[email protected]",
"todo": null,
"payment_amount": null
}
The ID of the offer.
The ID of the participant.
curl --request PUT \
"https://api.metapic.dev/v2/offers/9/participants/13/payment-amount" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payment_amount\": {
\"amount\": \"1.2\",
\"currency\": \"EUR\"
}
}"
{
"id": null,
"offer_id": 763,
"user_id": null,
"display_name": "[email protected]",
"clicks": 2,
"status": "have_posted",
"pre_registered_email": "[email protected]",
"todo": null,
"payment_amount": null
}
The ID of the offer.
The ID of the participant.
curl --request PATCH \
"https://api.metapic.dev/v2/offers/17/participants/12/overrides/clicks" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"click_limit\": 17
}"
{
"id": null,
"offer_id": 764,
"user_id": 3630,
"display_name": null,
"clicks": 620491887,
"status": "product_sent",
"todo": null,
"payment_amount": null
}
The ID of the offer.
The ID of the participant.
curl --request PATCH \
"https://api.metapic.dev/v2/offers/19/participants/1/overrides/costs" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": {
\"amount\": \"1.2\",
\"currency\": \"EUR\"
},
\"cpa\": 0.2
}
]
}"
{
"id": null,
"offer_id": 765,
"user_id": null,
"display_name": "axel06",
"clicks": 0,
"status": "have_posted",
"pre_registered_identifier": "axel06",
"todo": null,
"payment_amount": null
}
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/offer-by-token/blanditiis/users/9" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
cache-control
: no-cache, private
content-type
: application/json
access-control-allow-origin
: *
set-cookie
: metapic_session=eyJpdiI6IjhjQ2t4c3VBM3J2b1hTZVBFWGk0YUE9PSIsInZhbHVlIjoiQ3NDTkZVcUNrdFNVWUhKZU5lTjdaL0I4czhTNThXdk95ZHNYZFYrbVg3NEh6Zjh4cFpadnZmL2FtVUhlNzB6d1BSUzBHSDlBcUVmMEozNUJudVdVNWswRmNoVzI3UlRnWWtNdExVRXlOMWMyc0I5eklJdEh1bmF6QUw3V1gveGoiLCJtYWMiOiI1Njk1MTEzNjgzNWNmNWFhYThmZDc1YTA3OWMyZWRmODgyNTBmNGZmNmQ5Mzk2NTMwNjU5ZWQyYTk3ZmY2NDU3IiwidGFnIjoiIn0%3D; expires=Thu, 23 Oct 2025 16:07:51 GMT; Max-Age=7200; path=/; secure; httponly
{
"message": "Unauthenticated."
}
This can only be performed by the user themselves.
The ID of the user.
curl --request POST \
"https://api.metapic.dev/v2/offer-by-token/qui/users/6/join" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
The ID of the offerUser.
curl --request POST \
"https://api.metapic.dev/v2/offer-users/1/comments" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"comment\": \"tukyrkzjgboimg\"
}"
The ID of the offerUser.
The ID of the comment.
The ID of the comment.
curl --request PUT \
"https://api.metapic.dev/v2/offer-users/1/comments/16" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"comment\": \"pmvkateaboyrc\"
}"
The ID of the offerUser.
The ID of the comment.
The ID of the comment.
curl --request DELETE \
"https://api.metapic.dev/v2/offer-users/1/comments/10" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request GET \
--get "https://api.metapic.dev/v2/offer-users/quas/activities" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"include\": [
\"has_unread_notification\"
]
}"
cache-control
: no-cache, private
content-type
: application/json
x-ratelimit-limit
: 300
x-ratelimit-remaining
: 300
access-control-allow-origin
: *
{
"message": "Unauthenticated."
}
Creates a Hubspot deal for advertiser representative when triggered by an Ory registration.after webhook.
curl --request POST \
"https://api.metapic.dev/v2/webhooks/ory/identities/created" \
--header "mtpc-api-key: {mtpc-api-key}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"identity\": {
\"id\": \"ory_identity_id_123\",
\"traits\": {
\"email\": \"[email protected]\"
}
},
\"app_url\": \"https:\\/\\/advertiser.metapic.com\"
}"
[Empty response]
Updates a user when triggered by an Ory settings.after webhook.
curl --request POST \
"https://api.metapic.dev/v2/webhooks/ory/identities/updated" \
--header "mtpc-api-key: {mtpc-api-key}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"identity\": {
\"id\": \"ory_identity_id_123\",
\"traits\": {
\"email\": \"[email protected]\"
}
}
}"
[Empty response]
Paginated list of Return Ads
Page size. Defaults to 20. Must not be greater than 100.
Query by either of the following: ID or name.
Returns all return ads with id equal to query
OR name contains query
. Must not be greater than 64 characters.
Query by return ad's advertiser group. Returns all return ads which belong to the given advertiser_group_ids
.
Query by return ad's advertiser. Returns all return ads which belong to the given advertiser_ids
.
deleted
ended
scheduled
paused
active
Query by return ad's ID. Performs an 'OR' search, compared to 'AND' search for other filters, so an return ad with given ID is always included in the results, if matched.
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
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
name:asc
name:desc
created_at:asc
created_at:desc
starts_at:asc
starts_at:desc
ends_at:asc
ends_at:desc
current_clicks:asc
current_clicks:desc
current_views:asc
current_views:desc
order_count:asc
order_count:desc
order_value:asc
order_value:desc
earnings:asc
earnings:desc
click_through_rate:asc
click_through_rate:desc
conversion_rate:asc
conversion_rate:desc
curl --request GET \
--get "https://api.metapic.dev/v2/return-ads?size=20&query=internal+name&advertiser_group_ids[]=1&advertiser_ids[]=1&statuses[]=paused&created_by=&or_id=1234&sort_by=current_clicks%3Aasc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 276,
"name": "Fatima Botsford IV",
"advertiser_group_id": 4543,
"affiliate_link": {
"id": 843,
"url": "http://abernathy.com/veniam-aliquam-iusto-est-assumenda.html",
"original_url": "http://rowe.org/pariatur-quibusdam-molestiae-maxime-perferendis-aut-iure",
"mtpc_url": "https://c.mtpc.se/843",
"user_id": 3633,
"country": "ZA",
"provider": "white",
"advertiser": {
"id": 2210,
"name": "Prohaska, Hill and Kassulke"
}
},
"author_id": 3634,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWFhP3RleHQ9bGFib3Jl",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWFhP3RleHQ9bGFib3Jl",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWFhP3RleHQ9bGFib3Jl"
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
},
{
"id": 277,
"name": "Mr. Bertram Kozey II",
"advertiser_group_id": 4546,
"affiliate_link": {
"id": 844,
"url": "https://feil.com/fugiat-fuga-voluptatem-sed-qui.html",
"original_url": "http://www.goodwin.com/cum-voluptate-animi-voluptatibus-modi-non-voluptatem",
"mtpc_url": "https://c.mtpc.se/844",
"user_id": 3635,
"country": "KY",
"provider": "lime",
"advertiser": {
"id": 2211,
"name": "Stracke, Homenick and Kris"
}
},
"author_id": 3636,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWJiP3RleHQ9c2FlcGU=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWJiP3RleHQ9c2FlcGU=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWJiP3RleHQ9c2FlcGU="
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"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
}
}
curl --request POST \
"https://api.metapic.dev/v2/return-ads" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"nvr\",
\"advertiser_group_id\": 1,
\"advertiser_id\": 19,
\"return_link\": \"https:\\/\\/advertiser.com\",
\"display_for_all_advertisers\": true,
\"advertiser_ids\": [
9
],
\"advertiser_category_ids\": [
7
],
\"styles\": {
\"color\": \"#ffffff\"
},
\"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
\"starts_at\": \"2025-10-23T16:07:50\",
\"ends_at\": \"2070-02-23\",
\"click_limit\": 13,
\"view_limit\": 6
}"
{
"id": 278,
"name": "Vincenzo Jerde",
"advertiser_group_id": 4549,
"affiliate_link": {
"id": 845,
"url": "http://www.torp.biz/corrupti-recusandae-atque-tempore-qui-officiis-aspernatur-aut-exercitationem",
"original_url": "http://boehm.com/ut-et-tempore-quia-voluptatem",
"mtpc_url": "https://c.mtpc.se/845",
"user_id": 3637,
"country": "MA",
"provider": "yellow",
"advertiser": {
"id": 2212,
"name": "Kozey PLC"
}
},
"author_id": 3638,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODMzP3RleHQ9ZXhwbGljYWJv",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODMzP3RleHQ9ZXhwbGljYWJv",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODMzP3RleHQ9ZXhwbGljYWJv"
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
}
The ID of the return ad.
curl --request GET \
--get "https://api.metapic.dev/v2/return-ads/10" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 279,
"name": "Mrs. Cheyenne Tremblay PhD",
"advertiser_group_id": 4552,
"affiliate_link": {
"id": 846,
"url": "http://rohan.com/omnis-iusto-veniam-harum-rerum",
"original_url": "http://jerde.com/totam-autem-aut-est-voluptatum-error.html",
"mtpc_url": "https://c.mtpc.se/846",
"user_id": 3639,
"country": "SR",
"provider": "blue",
"advertiser": {
"id": 2213,
"name": "Schamberger, Lubowitz and Crist"
}
},
"author_id": 3640,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTU1P3RleHQ9YWI=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTU1P3RleHQ9YWI=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYTU1P3RleHQ9YWI="
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
}
The ID of the return ad.
curl --request PUT \
"https://api.metapic.dev/v2/return-ads/16" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"fxaetkdzwmruoaotbsuhggze\",
\"return_link\": \"https:\\/\\/advertiser.com\",
\"display_for_all_advertisers\": false,
\"advertiser_ids\": [
9
],
\"advertiser_category_ids\": [
1
],
\"styles\": {
\"color\": \"#ffffff\"
},
\"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
\"starts_at\": \"2025-10-23T16:07:50\",
\"ends_at\": \"2070-07-21\",
\"click_limit\": 16,
\"view_limit\": 7
}"
{
"id": 280,
"name": "Madonna Hane",
"advertiser_group_id": 4555,
"affiliate_link": {
"id": 847,
"url": "http://www.larson.biz/tempore-quaerat-esse-eaque.html",
"original_url": "http://kilback.biz/",
"mtpc_url": "https://c.mtpc.se/847",
"user_id": 3641,
"country": "LK",
"provider": "teal",
"advertiser": {
"id": 2214,
"name": "Bechtelar PLC"
}
},
"author_id": 3642,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OTAwP3RleHQ9Y29tbW9kaQ==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OTAwP3RleHQ9Y29tbW9kaQ==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OTAwP3RleHQ9Y29tbW9kaQ=="
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
}
The ID of the return ad.
curl --request DELETE \
"https://api.metapic.dev/v2/return-ads/3" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Deactivates Return Ad
The ID of the returnAd.
curl --request POST \
"https://api.metapic.dev/v2/return-ads/8/pause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 281,
"name": "Mrs. Scarlett McKenzie",
"advertiser_group_id": 4558,
"affiliate_link": {
"id": 848,
"url": "http://waelchi.com/",
"original_url": "http://emmerich.com/dicta-in-qui-dolor-iste-ipsam-aut",
"mtpc_url": "https://c.mtpc.se/848",
"user_id": 3643,
"country": "GR",
"provider": "gray",
"advertiser": {
"id": 2215,
"name": "Torp, Zulauf and Grimes"
}
},
"author_id": 3644,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWJiP3RleHQ9YXV0",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWJiP3RleHQ9YXV0",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWJiP3RleHQ9YXV0"
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
}
The ID of the returnAd.
curl --request POST \
"https://api.metapic.dev/v2/return-ads/7/unpause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 282,
"name": "Hester Quitzon",
"advertiser_group_id": 4561,
"affiliate_link": {
"id": 849,
"url": "http://www.brekke.net/itaque-aspernatur-ea-illo-dignissimos-beatae-quia-ipsum.html",
"original_url": "http://www.robel.com/et-voluptas-similique-et-vel-sint-illo-molestiae",
"mtpc_url": "https://c.mtpc.se/849",
"user_id": 3645,
"country": "TO",
"provider": "blue",
"advertiser": {
"id": 2216,
"name": "Flatley, Kiehn and Bartoletti"
}
},
"author_id": 3646,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWJiP3RleHQ9YXNwZXJuYXR1cg==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWJiP3RleHQ9YXNwZXJuYXR1cg==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWJiP3RleHQ9YXNwZXJuYXR1cg=="
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
}
List of Return Ads displayed for Advertiser by ID
The ID of the store.
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/19/return-ads" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 283,
"name": "Eliza Hickle",
"advertiser_group_id": 4564,
"affiliate_link": {
"id": 850,
"url": "http://www.okon.org/quia-quod-in-consequatur-enim-quia-possimus-qui-unde",
"original_url": "https://beahan.com/voluptas-minima-officiis-nihil-non-laudantium.html",
"mtpc_url": "https://c.mtpc.se/850",
"user_id": 3647,
"country": "CR",
"provider": "white",
"advertiser": {
"id": 2217,
"name": "Homenick Inc"
}
},
"author_id": 3648,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA3N2RkP3RleHQ9bWFpb3Jlcw==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA3N2RkP3RleHQ9bWFpb3Jlcw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA3N2RkP3RleHQ9bWFpb3Jlcw=="
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
},
{
"id": 284,
"name": "Johann Kuhic",
"advertiser_group_id": 4567,
"affiliate_link": {
"id": 851,
"url": "http://dickinson.com/",
"original_url": "http://www.dickens.com/",
"mtpc_url": "https://c.mtpc.se/851",
"user_id": 3649,
"country": "SG",
"provider": "lime",
"advertiser": {
"id": 2218,
"name": "Schimmel Ltd"
}
},
"author_id": 3650,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODIyP3RleHQ9dG90YW0=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODIyP3RleHQ9dG90YW0=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODIyP3RleHQ9dG90YW0="
},
"starts_at": "2025-09-23 16:07:50",
"ends_at": "2025-11-23 16:07:50",
"stats": []
}
]
List Shared Budgets for Store
The ID of the store.
curl --request GET \
--get "https://api.metapic.dev/v2/stores/12/shared-budgets" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 44,
"title": "Jayme Hills",
"amount": 9,
"amount_v2": {
"amount": "0.09",
"currency": "PLN"
},
"consumed_budget": 0,
"consumed_budget_v2": {
"amount": "0",
"currency": "PLN"
},
"currency": "PLN"
},
{
"id": 45,
"title": "Otto Lubowitz II",
"amount": 8,
"amount_v2": {
"amount": "0.08",
"currency": "USD"
},
"consumed_budget": 0,
"consumed_budget_v2": {
"amount": "0",
"currency": "USD"
},
"currency": "USD"
}
]
Returns information about a specific budget.
The ID of the store.
The ID of the shared budget.
curl --request GET \
--get "https://api.metapic.dev/v2/stores/9/shared-budgets/5" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 46,
"title": "Electa Hoeger MD",
"amount": 5,
"amount_v2": {
"amount": "0.05",
"currency": "SEK"
},
"consumed_budget": 0,
"consumed_budget_v2": {
"amount": "0",
"currency": "SEK"
},
"currency": "SEK"
}
Updates existing budget.
The ID of the store.
The ID of the shared budget.
curl --request PUT \
"https://api.metapic.dev/v2/stores/12/shared-budgets/6" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Summer budget\",
\"amount\": 10000
}"
{
"id": 47,
"title": "Marcos Schumm",
"amount": 9,
"amount_v2": {
"amount": "0.09",
"currency": "SEK"
},
"consumed_budget": 0,
"consumed_budget_v2": {
"amount": "0",
"currency": "SEK"
},
"currency": "SEK"
}
The ID of the store.
The ID of the shared budget.
curl --request DELETE \
"https://api.metapic.dev/v2/stores/13/shared-budgets/10" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request PUT \
"https://api.metapic.dev/v2/stores/15/payment" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"payment_setup_id\": \"fuga\"
}"
Uploads an image to tmp folder.
curl --request POST \
"https://api.metapic.dev/v2/image-uploads" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"image\": \"veritatis\"
}"
Endpoint for querying & sorting all users.
Query by either of the following: ID, username, email.
Returns all users with id equal to query
OR username contains query
OR email contains query
. Must not be greater than 64 characters.
Query by user's client. Returns all users which belong to the given client_id
.
Query by user's store group. Returns all users which belong to the given store_group_id
.
Page size. Defaults to 20. Must not be greater than 100.
Must follow the correct format: column_name:direction
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
curl --request GET \
--get "https://api.metapic.dev/v2/users?query=testcreator123&client_id=2&store_group_id=15&size=20&sort_by=quia" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 3653,
"username": "yasmine.kunze",
"display_name": "Kaden Green",
"email": "[email protected]",
"client_id": 3837
},
{
"id": 3654,
"username": "dean.littel",
"display_name": "Nicolas Dibbert",
"email": "[email protected]",
"client_id": 3838
}
],
"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
}
}
Requires an Ory-issued JWT for a session not yet linked to a Metapic user (no user_id).
curl --request POST \
"https://api.metapic.dev/v2/users" \
--header "Authorization: Bearer {JWT}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"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\"
}"
{
"id": 3655,
"username": "mekhi.ruecker",
"display_name": "Eldred Heaney",
"email": "[email protected]",
"client_id": 3839
}
Query by user's advertiser group. Returns all users which belong to the given advertiser_group_id
.
a mix array of user emails and ids. Must not have more than 1000 items.
curl --request POST \
"https://api.metapic.dev/v2/match-users?advertiser_group_id=15&user_emails_or_ids[]=12345&user_emails_or_ids[]=email%40metapic.com" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Endpoint for querying & sorting all user tags.
Query by user tag's name. Returns all user tags whose name contains the given name
. Must not be greater than 255 characters.
Query by user tag's store. Returns all user tags which belong to the given store_id
.
Query by user tag's access levels. Returns all user tags which have the given access_levels
:
0
1
2
Page size. Defaults to 20. Must not be greater than 100.
Must follow the correct format: column_name:direction
,
where column_name
must be a valid property for given resource and direction
can be one of asc|desc
,
both of which are required if sort_by
is present.
curl --request GET \
--get "https://api.metapic.dev/v2/user-tags?name=favourites&store_id=15&access_levels[]=0&access_levels[]=1&size=20&sort_by=reiciendis" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"