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/16/blocklist?query=gzthqldcegko" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 73,
"created_at": "2025-06-30 11:02:43",
"created_by": {
"id": 3308,
"username": "renner.myrtie",
"email": "[email protected]",
"client_id": 3420
},
"user_tag": {
"id": 1970,
"name": "Johnson Keebler III",
"slug": "ut-quae",
"access_level": 1,
"store_id": null
}
},
{
"id": 74,
"created_at": "2025-06-30 11:02:43",
"created_by": {
"id": 3309,
"username": "everette29",
"email": "[email protected]",
"client_id": 3421
},
"user_tag": {
"id": 1971,
"name": "Jeremy Lynch",
"slug": "sit-facilis",
"access_level": 1,
"store_id": 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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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/7/blocklist" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"user_ids\": [
23
],
\"user_tag_ids\": [
10
]
}"
The ID of the advertiser.
The ID of the target.
curl --request DELETE \
"https://api.metapic.dev/v2/advertisers/2/blocklist/12" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Returns the WooCommerce tracking configuration for the advertiser.
The advertiser.
curl --request GET \
--get "https://api.metapic.dev/v2/advertisers/ea/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\": \"consequatur\"
}"
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=created_at%3Adesc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 4114,
"name": "McLaughlin-Kreiger",
"key": "cch_NG",
"currency": "GBP"
},
{
"id": 4115,
"name": "Hansen, Collins and Stroman",
"key": "dz_BT",
"currency": "PLN"
}
],
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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/eum" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 830,
"url": "http://mohr.org/",
"original_url": "https://www.skiles.biz/ab-eaque-et-et-et-numquam-officiis",
"mtpc_url": "https://c.mtpc.se/830",
"user_id": 3312,
"country": "MO",
"provider": "black",
"advertiser": {
"id": 2011,
"name": "Lindgren, Sipes and Veum"
}
}
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\": 13,
\"advertiser_preview\": true,
\"advertiser_group_id\": 1,
\"dry\": false
}"
{
"status": "success",
"affiliate_link": {
"status": "success",
"id": 831,
"url": "http://www.collier.biz/aut-iusto-mollitia-vel-possimus.html",
"original_url": "http://www.reynolds.com/",
"mtpc_url": "https://c.mtpc.se/831",
"user_id": 3313,
"country": "CR",
"provider": "navy",
"advertiser": {
"id": 2012,
"name": "Dare PLC"
}
}
}
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=created_at%3Adesc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 3422,
"name": "Ramiro Goldner",
"client_id": "bFOtN8R608",
"has_own_payment_system": false,
"revenue_share": 1
},
{
"id": 3423,
"name": "Levi Renner",
"client_id": "O8DyqhWwUD",
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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=quis&status=all&type=all&favorite=1&group=4&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": 59,
"name": "Food"
},
{
"id": 60,
"name": "Food"
}
]
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-06\"
}"
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/8/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/5/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\": \"nbsirhlblwgs\"
}"
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\": \"pwatzxqimjnc\"
}"
curl --request GET \
--get "https://api.metapic.dev/v2/entrypoint" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"app\": \"advertiser\",
\"store_id\": 9
}"
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/{X#" \
--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\": 6,
\"type\": \"suggestion\",
\"name\": \"Summer campaign for VIP creators\",
\"campaign_title\": \"Summer campaign\",
\"campaign_text\": \"This is a summer campaign!\",
\"has_product_seeding\": true,
\"has_onetime_payment\": false,
\"per_user_limit\": true,
\"one_time_payment\": 6,
\"budget_limit\": 6,
\"max_clicks\": 15,
\"valid_from\": \"2025-06-30T13:02:41\",
\"valid_until\": \"2036-11-21\",
\"todo\": [
\"hmfdckvliqzybyhdstc\"
],
\"show_for_advertiser\": true,
\"priority_after\": 7,
\"shared_budget_id\": 1,
\"shared_budget\": {
\"title\": \"Summer budget\",
\"amount\": 10000
},
\"targets\": {
\"user_ids\": [
5
],
\"user_tag_ids\": [
3
],
\"store_group_ids\": [
1
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"jaccuyqmwvzmc\"
],
\"client_ids\": [
12
],
\"revenue_tier_ids\": [
8
]
},
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": 230,
\"cpa\": 0.2,
\"invoice_cpc\": 250,
\"invoice_cpa\": 0.25,
\"user_revenue\": 1
}
]
}"
{
"data": {
"id": 695,
"campaign_title": "Dr. Courtney Dickens DVM",
"campaign_text": "Ab qui eos dolore voluptas rem tenetur aut quaerat. Repellendus aut amet omnis. Est exercitationem autem est atque.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmZmP3RleHQ9YmxhbmRpdGlpcw==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmZmP3RleHQ9YmxhbmRpdGlpcw==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmZmP3RleHQ9YmxhbmRpdGlpcw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmZmP3RleHQ9YmxhbmRpdGlpcw=="
},
"store_id": 1971,
"store_name": "Becker, Ryan and Harris",
"store_logo_url": null,
"store_logo": null,
"currency": "USD",
"token": "xm3vlsm710utklgg",
"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": 696,
"campaign_title": "Claire Reynolds Sr.",
"campaign_text": "Est cum aliquam dolor delectus laborum quam et animi. Harum corporis cupiditate facilis voluptatem eveniet voluptas quo. Maxime pariatur aliquam officiis saepe nemo et placeat.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDg4P3RleHQ9aW4=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDg4P3RleHQ9aW4=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDg4P3RleHQ9aW4=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDg4P3RleHQ9aW4="
},
"store_id": 1972,
"store_name": "Hyatt, Rosenbaum and Smitham",
"store_logo_url": null,
"store_logo": null,
"currency": "USD",
"token": "t9ir1ipnl3uajdau",
"traffic_sources_costs": [
{
"id": 208,
"source": 0,
"source_name": "General",
"cpc": null,
"cpa": null,
"currency": "USD"
}
],
"type": "standard"
}
Updates existing campaign.
The ID of the offer.
The offer ID
curl --request PUT \
"https://api.metapic.dev/v2/offers/6" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"store_group_id\": 4,
\"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\": false,
\"one_time_payment\": 729.36,
\"budget_limit\": 20,
\"max_clicks\": 8,
\"valid_from\": \"2025-06-30T13:02:42\",
\"valid_until\": \"1990-01-14\",
\"todo\": [
\"jzicfeh\"
],
\"show_for_advertiser\": true,
\"priority_after\": 13,
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": 230,
\"cpa\": 0.2,
\"invoice_cpc\": 250,
\"invoice_cpa\": 0.25,
\"user_revenue\": 0
}
],
\"targets\": {
\"0\": [],
\"user_ids\": [
10
],
\"user_tag_ids\": [
18
],
\"store_group_ids\": [
18
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"wcnifkg\"
],
\"client_ids\": [
10
],
\"revenue_tier_ids\": [
20
]
},
\"shared_budget_id\": 1,
\"shared_budget\": {
\"title\": \"Summer budget\",
\"amount\": 10000
}
}"
{
"data": {
"id": 697,
"campaign_title": "Prof. Luisa Sipes DDS",
"campaign_text": "Ratione aspernatur nam consectetur molestiae soluta dolorum. Dolor architecto qui itaque aspernatur expedita. Minima nihil et ut repellendus soluta.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjMzP3RleHQ9ZXhwZWRpdGE=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjMzP3RleHQ9ZXhwZWRpdGE=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjMzP3RleHQ9ZXhwZWRpdGE=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjMzP3RleHQ9ZXhwZWRpdGE="
},
"store_id": 1973,
"store_name": "Hill LLC",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "3st77s06xvhxlr99",
"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/11" \
--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
Include optional relationships in the response.
trafficSourcesCosts
store
targets
sharedBudget
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=7&or_id=1234&target_user_id=20&size=20&sort_by=created_at%3Adesc&custom_sort_by=ends_soon&include[]=store&format=xlsx&show_for_advertiser=&advertiser_id=123" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 698,
"campaign_title": "Eusebio Feeney",
"campaign_text": "Eum iure hic deleniti rerum. Placeat vel rerum quasi aspernatur repellat corporis est. Odio impedit eveniet voluptas libero. Fugiat nesciunt ipsa unde eveniet est. Est qui placeat aut.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmNjP3RleHQ9YXQ=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmNjP3RleHQ9YXQ=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmNjP3RleHQ9YXQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmNjP3RleHQ9YXQ="
},
"store_id": 1974,
"store_name": "Gutmann, Davis and Hackett",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "zmobr5ocmlwpuc6y",
"type": "standard"
},
{
"id": 699,
"campaign_title": "Mr. Wilmer Metz Sr.",
"campaign_text": "Quia et ut iste. Qui assumenda maxime sunt. Velit incidunt odio consequuntur. Sit qui aut explicabo eius. Debitis natus aut omnis nemo architecto. Vitae nihil et quisquam.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9Y29uc2VxdWF0dXI=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9Y29uc2VxdWF0dXI=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9Y29uc2VxdWF0dXI=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9Y29uc2VxdWF0dXI="
},
"store_id": 1975,
"store_name": "Mertz-Gusikowski",
"store_logo_url": null,
"store_logo": null,
"currency": "EUR",
"token": "qqpop4tld9uy3w6o",
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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\": \"qui\"
}"
{
"id": 700,
"campaign_title": "Prof. Herbert Gerhold",
"campaign_text": "Officia id nemo similique possimus maiores non. Vero animi voluptatem ut fugit perspiciatis numquam fuga.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9aXVzdG8=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9aXVzdG8=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9aXVzdG8=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9aXVzdG8="
},
"store_id": 1976,
"store_name": "Wilkinson-Gislason",
"store_logo_url": null,
"store_logo": null,
"currency": "PLN",
"token": "mym34zf69dmn5h8i",
"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": 701,
"campaign_title": "Ms. Loma Witting V",
"campaign_text": "Ex nostrum fugit doloremque nesciunt sint vel. Delectus ipsa et id facere. Aut vel exercitationem aut quae minima illum.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmJiP3RleHQ9aWxsdW0=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmJiP3RleHQ9aWxsdW0=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmJiP3RleHQ9aWxsdW0=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmJiP3RleHQ9aWxsdW0="
},
"store_id": 1977,
"store_name": "Torp-Lowe",
"store_logo_url": null,
"store_logo": null,
"currency": "GBP",
"token": "fmgozr4wl7crou8l",
"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": 702,
"campaign_title": "Ms. Aniyah Prosacco III",
"campaign_text": "Dolor sit adipisci numquam quod est quibusdam repellat. Omnis blanditiis debitis debitis ut cumque.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjExP3RleHQ9cXVhc2k=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjExP3RleHQ9cXVhc2k=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjExP3RleHQ9cXVhc2k=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjExP3RleHQ9cXVhc2k="
},
"store_id": 1978,
"store_name": "White LLC",
"store_logo_url": null,
"store_logo": null,
"currency": "SEK",
"token": "vxmbhlvq83bwmmhh",
"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\": \"2009-01-31\",
\"end_date\": \"2099-02-23\"
}"
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/11/offers" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"accepted\",
\"name\": \"ptj\"
}"
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/nesciunt" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 714,
"campaign_title": "Dr. Marlen Stokes Sr.",
"campaign_text": "Iste earum assumenda placeat dolor et. Quis aut in quaerat quidem sit quo dolor non.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9cmVt",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9cmVt",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9cmVt",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODk5P3RleHQ9cmVt"
},
"store_id": 2013,
"store_name": "Cronin-Steuber",
"store_logo_url": null,
"store_logo": null,
"currency": "EUR",
"token": "cvnuaf18rql5o2t8",
"traffic_sources_costs": [
{
"id": 209,
"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\": [
3
],
\"user_tag_ids\": [
15
],
\"store_group_ids\": [
20
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"nydmrytxvntpuly\"
],
\"client_ids\": [
15
],
\"revenue_tier_ids\": [
11
]
}"
The ID of the offer.
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/2/users/12" \
--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/3/participants" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"query\": \"bbrypnkdfjhcxfrsoasauxhz\",
\"status\": \"done\",
\"include\": [
\"offer_comments_count\"
]
}"
{
"data": [
{
"id": null,
"offer_id": 704,
"user_id": null,
"display_name": "[email protected]",
"clicks": 14055,
"status": "suggestion",
"pre_registered_email": "[email protected]",
"todo": null,
"payment_amount": null
},
{
"id": null,
"offer_id": 706,
"user_id": null,
"display_name": "vnikolaus",
"clicks": 86719446,
"status": "suggestion",
"pre_registered_identifier": "vnikolaus",
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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/14/participants/1" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": null,
"offer_id": 707,
"user_id": 3282,
"display_name": "[email protected]",
"clicks": 2370,
"status": "done",
"todo": null,
"payment_amount": null,
"social_media": [],
"tags": [
{
"id": 1969,
"name": "Dr. Dedrick Hyatt PhD",
"slug": "et-consequatur",
"access_level": 1,
"store_id": 1984
}
]
}
The ID of the offer.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/10/participants-stats" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"query\": \"ymloxyhibbyodfwajjpgg\",
\"active\": true,
\"start_date\": \"2022-04-28\",
\"end_date\": \"2037-02-10\",
\"sort_by\": \"estimated_earning_to_cost_ratio:desc\"
}"
{
"data": [
{
"id": null,
"user_id": null,
"display_name": "[email protected]",
"clicks": 0,
"status": "store_denied",
"links_created": null,
"estimated_gp": null,
"estimated_earning_to_cost_ratio": null
},
{
"id": null,
"user_id": null,
"display_name": "aurelia.eichmann",
"clicks": 0,
"status": "done",
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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/5/participants-count-by-click-activity" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start_date\": \"2002-05-07\",
\"end_date\": \"2114-07-18\"
}"
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/7/participants/6/update-status" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"have_received\"
}"
{
"id": null,
"offer_id": 710,
"user_id": 3285,
"display_name": null,
"clicks": 58862,
"status": "done",
"todo": null,
"payment_amount": null
}
The ID of the offer.
The ID of the participant.
curl --request PATCH \
"https://api.metapic.dev/v2/offers/10/participants/2/todo" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"todo\": [
{
\"key\": \"hniiowqpy\",
\"value\": false
}
]
}"
{
"id": null,
"offer_id": 711,
"user_id": null,
"display_name": "[email protected]",
"clicks": 1726,
"status": "applied",
"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/12/participants/5/overrides/clicks" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"click_limit\": 4
}"
{
"id": null,
"offer_id": 712,
"user_id": null,
"display_name": "era76",
"clicks": 870,
"status": "applied",
"pre_registered_identifier": "era76",
"todo": null,
"payment_amount": null
}
The ID of the offer.
The ID of the participant.
curl --request PATCH \
"https://api.metapic.dev/v2/offers/7/participants/17/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": 713,
"user_id": null,
"display_name": "icarroll",
"clicks": 9,
"status": "have_received",
"pre_registered_identifier": "icarroll",
"todo": null,
"payment_amount": null
}
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/offer-by-token/cupiditate/users/15" \
--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=eyJpdiI6InNIZTJNUDFweUFDWnVydDdwR1VXNFE9PSIsInZhbHVlIjoiMU44M2FTY2QvR1R0cjJmd0dPTDlpM1VHMS94OUhEYkYxR3ZzYUdMWEZ5WFp1TU5iVzI0VEVaMFJEM0szZTUxVi9TU2Y2SDYwR1pLZ1NJRGhiN1R0L1MvY0c2RFdCK082YkJTQVJnQUQzbE44N3YrWEdNQUk1RUo2YUxQbnlDSHoiLCJtYWMiOiJiNmVmMjhkOTM4ZDI1Mzc5ZDUyZmZhMGUwODIzM2Y5OTY1OWZhZDk0Y2FmZWYwMDE5ZWJmNTM4NTEzYTI4MzRiIiwidGFnIjoiIn0%3D; expires=Mon, 30 Jun 2025 13:02:43 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/quod/users/3/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\": \"rtehebohkedyvnoiuvhv\"
}"
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/1" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"comment\": \"wmlzkypywdriqupvtsq\"
}"
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/12" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request GET \
--get "https://api.metapic.dev/v2/offer-users/saepe/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."
}
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[]=deleted&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": "Aliza O'Conner",
"advertiser_group_id": 4081,
"affiliate_link": {
"id": 821,
"url": "https://www.auer.com/cupiditate-nemo-corporis-qui-omnis-voluptas-delectus-modi-provident",
"original_url": "http://www.jacobson.biz/fuga-sit-voluptatem-qui-numquam.html",
"mtpc_url": "https://c.mtpc.se/821",
"user_id": 3290,
"country": "BY",
"provider": "teal",
"advertiser": {
"id": 1995,
"name": "Ratke, Mante and Klocko"
}
},
"author_id": 3291,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWZmP3RleHQ9dmVsaXQ=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWZmP3RleHQ9dmVsaXQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWZmP3RleHQ9dmVsaXQ="
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
},
{
"id": 277,
"name": "Caroline Walter",
"advertiser_group_id": 4084,
"affiliate_link": {
"id": 822,
"url": "http://pacocha.com/velit-quam-ut-rerum-quis-et-consectetur",
"original_url": "http://connelly.biz/neque-ducimus-quos-ea",
"mtpc_url": "https://c.mtpc.se/822",
"user_id": 3292,
"country": "JM",
"provider": "navy",
"advertiser": {
"id": 1996,
"name": "D'Amore Ltd"
}
},
"author_id": 3293,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMGZmP3RleHQ9ZXN0",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMGZmP3RleHQ9ZXN0",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMGZmP3RleHQ9ZXN0"
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"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\": \"hivxmnw\",
\"advertiser_group_id\": 4,
\"advertiser_id\": 18,
\"return_link\": \"https:\\/\\/advertiser.com\",
\"display_for_all_advertisers\": false,
\"advertiser_ids\": [
5
],
\"advertiser_category_ids\": [
16
],
\"styles\": {
\"color\": \"#ffffff\"
},
\"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
\"starts_at\": \"2025-06-30T13:02:42\",
\"ends_at\": \"2039-12-19\",
\"click_limit\": 13,
\"view_limit\": 19
}"
{
"id": 278,
"name": "Dr. Jovan Bayer DVM",
"advertiser_group_id": 4087,
"affiliate_link": {
"id": 823,
"url": "http://www.price.com/quia-commodi-quia-ipsum-voluptas-ipsam-quisquam",
"original_url": "http://leuschke.info/autem-vitae-in-adipisci-eligendi.html",
"mtpc_url": "https://c.mtpc.se/823",
"user_id": 3294,
"country": "MD",
"provider": "navy",
"advertiser": {
"id": 1997,
"name": "Stokes PLC"
}
},
"author_id": 3295,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMTg4P3RleHQ9ZHVjaW11cw==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMTg4P3RleHQ9ZHVjaW11cw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMTg4P3RleHQ9ZHVjaW11cw=="
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
}
The ID of the return ad.
curl --request GET \
--get "https://api.metapic.dev/v2/return-ads/16" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 279,
"name": "Colby Hintz",
"advertiser_group_id": 4090,
"affiliate_link": {
"id": 824,
"url": "http://www.botsford.com/nam-ducimus-et-quam-sint-repellendus-sed-aut.html",
"original_url": "http://lakin.com/",
"mtpc_url": "https://c.mtpc.se/824",
"user_id": 3296,
"country": "DE",
"provider": "green",
"advertiser": {
"id": 1998,
"name": "Murazik PLC"
}
},
"author_id": 3297,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjMzP3RleHQ9bm9u",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjMzP3RleHQ9bm9u",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjMzP3RleHQ9bm9u"
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
}
The ID of the return ad.
curl --request PUT \
"https://api.metapic.dev/v2/return-ads/2" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"eddx\",
\"return_link\": \"https:\\/\\/advertiser.com\",
\"display_for_all_advertisers\": false,
\"advertiser_ids\": [
16
],
\"advertiser_category_ids\": [
15
],
\"styles\": {
\"color\": \"#ffffff\"
},
\"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
\"starts_at\": \"2025-06-30T13:02:42\",
\"ends_at\": \"2043-10-05\",
\"click_limit\": 19,
\"view_limit\": 2
}"
{
"id": 280,
"name": "Gregoria Steuber",
"advertiser_group_id": 4093,
"affiliate_link": {
"id": 825,
"url": "http://www.hammes.net/sed-dolorum-quam-voluptatem-odit-et-veniam-ut",
"original_url": "http://heaney.com/voluptatum-omnis-quia-totam-aut",
"mtpc_url": "https://c.mtpc.se/825",
"user_id": 3298,
"country": "FK",
"provider": "gray",
"advertiser": {
"id": 1999,
"name": "Paucek-Jakubowski"
}
},
"author_id": 3299,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZG9sb3J1bQ==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZG9sb3J1bQ==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZG9sb3J1bQ=="
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
}
The ID of the return ad.
curl --request DELETE \
"https://api.metapic.dev/v2/return-ads/1" \
--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/4/pause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 281,
"name": "Emilie Schimmel",
"advertiser_group_id": 4096,
"affiliate_link": {
"id": 826,
"url": "http://www.kautzer.biz/consequatur-est-ipsam-rerum-sunt-dolores.html",
"original_url": "http://www.luettgen.com/odit-ex-ea-aut-nam",
"mtpc_url": "https://c.mtpc.se/826",
"user_id": 3300,
"country": "HT",
"provider": "black",
"advertiser": {
"id": 2000,
"name": "Ziemann Ltd"
}
},
"author_id": 3301,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmFhP3RleHQ9ZW9z",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmFhP3RleHQ9ZW9z",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmFhP3RleHQ9ZW9z"
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
}
The ID of the returnAd.
curl --request POST \
"https://api.metapic.dev/v2/return-ads/6/unpause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 282,
"name": "Prof. Rex Lueilwitz I",
"advertiser_group_id": 4099,
"affiliate_link": {
"id": 827,
"url": "http://www.mills.net/",
"original_url": "http://www.fisher.org/sapiente-ut-perspiciatis-ab",
"mtpc_url": "https://c.mtpc.se/827",
"user_id": 3302,
"country": "MK",
"provider": "aqua",
"advertiser": {
"id": 2001,
"name": "Terry, Altenwerth and Cruickshank"
}
},
"author_id": 3303,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2JiP3RleHQ9ZnVnaWF0",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2JiP3RleHQ9ZnVnaWF0",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2JiP3RleHQ9ZnVnaWF0"
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"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/2/return-ads" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 283,
"name": "Laurie Schmidt",
"advertiser_group_id": 4102,
"affiliate_link": {
"id": 828,
"url": "http://gutmann.com/et-quia-quas-corrupti-ea",
"original_url": "https://bradtke.org/dolore-reiciendis-autem-ipsam-ea-ab.html",
"mtpc_url": "https://c.mtpc.se/828",
"user_id": 3304,
"country": "DZ",
"provider": "silver",
"advertiser": {
"id": 2002,
"name": "Wunsch-Renner"
}
},
"author_id": 3305,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2RkP3RleHQ9cmVpY2llbmRpcw==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2RkP3RleHQ9cmVpY2llbmRpcw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2RkP3RleHQ9cmVpY2llbmRpcw=="
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
},
{
"id": 284,
"name": "Cecil Romaguera IV",
"advertiser_group_id": 4105,
"affiliate_link": {
"id": 829,
"url": "https://www.kohler.net/debitis-blanditiis-eligendi-blanditiis-nesciunt-quo",
"original_url": "http://leuschke.com/ut-quibusdam-repellat-fugiat-aut",
"mtpc_url": "https://c.mtpc.se/829",
"user_id": 3306,
"country": "GS",
"provider": "green",
"advertiser": {
"id": 2003,
"name": "Maggio LLC"
}
},
"author_id": 3307,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmRkP3RleHQ9dXQ=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmRkP3RleHQ9dXQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYmRkP3RleHQ9dXQ="
},
"starts_at": "2025-05-30 13:02:42",
"ends_at": "2025-07-30 13:02:42",
"stats": []
}
]
List Shared Budgets for Store
The ID of the store.
curl --request GET \
--get "https://api.metapic.dev/v2/stores/13/shared-budgets" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 42,
"title": "Una Gutmann",
"amount": 1,
"consumed_budget": 0,
"currency": "EUR"
},
{
"id": 43,
"title": "Jennifer Schumm",
"amount": 3,
"consumed_budget": 0,
"currency": "SEK"
}
]
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/7/shared-budgets/14" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 44,
"title": "Kaley Schoen",
"amount": 5,
"consumed_budget": 0,
"currency": "EUR"
}
Updates existing budget.
The ID of the store.
The ID of the shared budget.
curl --request PUT \
"https://api.metapic.dev/v2/stores/19/shared-budgets/11" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Summer budget\",
\"amount\": 10000
}"
{
"id": 45,
"title": "Dell Wisozk",
"amount": 1,
"consumed_budget": 0,
"currency": "USD"
}
The ID of the store.
The ID of the shared budget.
curl --request DELETE \
"https://api.metapic.dev/v2/stores/5/shared-budgets/17" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
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=created_at%3Adesc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 2006,
"name": "Hoppe and Sons"
},
{
"id": 2007,
"name": "Witting, Ryan and Thiel"
}
],
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "/",
"per_page": 20,
"to": 2,
"total": 2
}
}
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:\\/\\/hane.net\\/\",
\"country\": \" Example: SE\",
\"currency\": \"Example: EUR\",
\"language\": \"sv\",
\"billing\": {
\"company_name\": \"accusamus\",
\"street\": \"iure\",
\"postal_code\": \"est\",
\"city\": \"laborum\",
\"vat_number\": \"sint\"
}
}"
{
"id": 2008,
"name": "Adams, Kulas and Johnson"
}
The ID of the store.
curl --request PUT \
"https://api.metapic.dev/v2/stores/6/payment" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
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\": \"dolores\"
}"
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=created_at%3Adesc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 3310,
"username": "price.chelsie",
"email": "[email protected]",
"client_id": 3424
},
{
"id": 3311,
"username": "williamson.wilford",
"email": "[email protected]",
"client_id": 3425
}
],
"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",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "/",
"per_page": 20,
"to": 2,
"total": 2
}
}
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=created_at%3Adesc" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"