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/12/blocklist?query=pgzerchgehpqqsqqkrhx" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 73,
"created_at": "2025-04-01 11:27:59",
"created_by": {
"id": 3042,
"username": "rborer",
"email": "[email protected]",
"client_id": 3147
},
"user_tag": {
"id": 133,
"name": "Rey Prosacco",
"slug": "voluptas-autem-quos",
"access_level": 1,
"store_id": null
}
},
{
"id": 74,
"created_at": "2025-04-01 11:27:59",
"created_by": {
"id": 3043,
"username": "roberts.brooke",
"email": "[email protected]",
"client_id": 3148
},
"user_tag": {
"id": 134,
"name": "Prof. Maynard Mueller Jr.",
"slug": "similique-quia",
"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/11/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/7/blocklist/10" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
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": 3786,
"name": "Schaefer Inc",
"key": "fo_FO",
"currency": "PLN"
},
{
"id": 3787,
"name": "Frami-Schultz",
"key": "zh_MO",
"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",
"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/tempore" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 794,
"url": "https://stanton.org/praesentium-labore-qui-nulla-a-dicta.html",
"original_url": "http://kihn.com/",
"mtpc_url": "https://c.mtpc.se/794",
"user_id": 3046,
"country": "FM",
"provider": "yellow",
"advertiser": {
"id": 1806,
"name": "Heathcote LLC"
}
}
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\": 2,
\"advertiser_preview\": true,
\"advertiser_group_id\": 1,
\"dry\": true
}"
{
"status": "success",
"affiliate_link": {
"status": "success",
"id": 795,
"url": "http://www.mueller.com/sit-et-asperiores-quasi-facilis-sint.html",
"original_url": "http://www.marvin.info/amet-maxime-qui-magnam-nesciunt-a-temporibus",
"mtpc_url": "https://c.mtpc.se/795",
"user_id": 3047,
"country": "RW",
"provider": "teal",
"advertiser": {
"id": 1807,
"name": "Johns-Howe"
}
}
}
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": 3149,
"name": "Drew Jaskolski IV",
"client_id": "EZgS0MUdSK",
"has_own_payment_system": false,
"revenue_share": 1
},
{
"id": 3150,
"name": "Myrtice Donnelly",
"client_id": "DOKh0ravXA",
"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=blanditiis&status=2&type=instagram&favorite=1&group=17&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/store-categories" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 49,
"name": "Beauty"
},
{
"id": 50,
"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-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/11/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/13/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\": \"ygmfxkg\"
}"
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\": \"fmyibjwfafbdjdvqjl\"
}"
curl --request GET \
--get "https://api.metapic.dev/v2/entrypoint" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"app\": \"agency\",
\"store_id\": 2
}"
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\": 15,
\"type\": \"user_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\": false,
\"per_user_limit\": false,
\"one_time_payment\": 7365645.81589113,
\"budget_limit\": 10,
\"max_clicks\": 12,
\"valid_from\": \"2025-04-01T13:27:58\",
\"valid_until\": \"2002-07-08\",
\"todo\": [
\"thpsizjpixxd\"
],
\"show_for_advertiser\": false,
\"priority_after\": 4,
\"shared_budget_id\": 1,
\"shared_budget\": {
\"title\": \"Summer budget\",
\"amount\": 10000
},
\"targets\": {
\"user_ids\": [
5
],
\"user_tag_ids\": [
4
],
\"store_group_ids\": [
5
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"ldznqgwnm\"
],
\"client_ids\": [
11
],
\"revenue_tier_ids\": [
13
]
},
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": 230,
\"cpa\": 0.2,
\"invoice_cpc\": 250,
\"invoice_cpa\": 0.25,
\"user_revenue\": 1
}
]
}"
{
"data": {
"id": 602,
"campaign_title": "Marquis Stamm",
"campaign_text": "Doloremque et ut nihil. Dolore facere dolor itaque veniam vitae. Ipsam fugit ab eos. Et numquam perspiciatis veniam eum quae.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9YXV0",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9YXV0",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9YXV0",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjExP3RleHQ9YXV0"
},
"store_id": 1766,
"token": "lzwt5dnv9w0p3uuq",
"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": 603,
"campaign_title": "Miss Roselyn Prohaska",
"campaign_text": "Qui dolor recusandae totam odio facere voluptatibus ullam. Maiores quos aut repellat et.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9ZXg=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9ZXg=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9ZXg=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9ZXg="
},
"store_id": 1767,
"store_name": "Okuneva-Gorczany",
"store_logo_url": null,
"store_logo": null,
"currency": "USD",
"token": "g9ujj57id4gpv5yx",
"traffic_sources_costs": [
{
"id": 201,
"source": 0,
"source_name": "General",
"cpc": 1,
"cpc_v2": {
"amount": "0.01",
"currency": "USD"
},
"cpa": 0.04,
"currency": "USD"
}
],
"type": "standard"
}
Updates existing campaign.
The ID of the offer.
The offer ID
curl --request PUT \
"https://api.metapic.dev/v2/offers/12" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"store_group_id\": 12,
\"type\": \"standard\",
\"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\": false,
\"one_time_payment\": 247.899,
\"budget_limit\": 8,
\"max_clicks\": 12,
\"valid_from\": \"2025-04-01T13:27:58\",
\"valid_until\": \"2015-01-15\",
\"todo\": [
\"ndypxikbrdlblxm\"
],
\"show_for_advertiser\": true,
\"priority_after\": 14,
\"traffic_sources_costs\": [
{
\"source\": 1,
\"cpc\": 230,
\"cpa\": 0.2,
\"invoice_cpc\": 250,
\"invoice_cpa\": 0.25,
\"user_revenue\": 1
}
],
\"targets\": {
\"0\": [],
\"user_ids\": [
17
],
\"user_tag_ids\": [
15
],
\"store_group_ids\": [
5
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"aiolce\"
],
\"client_ids\": [
4
],
\"revenue_tier_ids\": [
14
]
},
\"shared_budget_id\": 1,
\"shared_budget\": {
\"title\": \"Summer budget\",
\"amount\": 10000
}
}"
{
"data": {
"id": 604,
"campaign_title": "Prof. Linda Hayes",
"campaign_text": "Nemo porro laborum dolores. Ab quis voluptas magnam laborum reiciendis neque. Quidem sit aperiam dicta at ipsam aperiam. Dolores voluptates est error et omnis vitae labore.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9YWQ=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9YWQ=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9YWQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjQ0P3RleHQ9YWQ="
},
"store_id": 1768,
"token": "f8uo6802kagaivx7",
"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/7" \
--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
curl --request GET \
--get "https://api.metapic.dev/v2/offers?query=black+friday&statuses[]=paused&store_ids[]=1&store_group_ids[]=1&created_by=11&or_id=1234&target_user_id=12&size=20&sort_by=created_at%3Adesc&custom_sort_by=ends_soon&include[]=targets&format=xlsx" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 605,
"campaign_title": "Coleman Wisozk",
"campaign_text": "Unde veniam qui illum eaque veniam. Aperiam aspernatur temporibus perspiciatis maxime consectetur. Sed cumque consequatur voluptatem ut unde sunt.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2JiP3RleHQ9ZWl1cw==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2JiP3RleHQ9ZWl1cw==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2JiP3RleHQ9ZWl1cw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzM2JiP3RleHQ9ZWl1cw=="
},
"store_id": 1769,
"token": "gtrdeqax2kdgk9h3",
"type": "standard"
},
{
"id": 606,
"campaign_title": "Adelbert Runte",
"campaign_text": "Sed dolorem dolore illum harum a quos molestiae accusamus. Eius eveniet officia praesentium est veniam cum numquam. Temporibus sed iusto est consectetur voluptas vel rerum fugiat.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjAwP3RleHQ9b21uaXM=",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjAwP3RleHQ9b21uaXM=",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjAwP3RleHQ9b21uaXM=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjAwP3RleHQ9b21uaXM="
},
"store_id": 1770,
"token": "nekeciup0bp2jsp0",
"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\": \"eos\"
}"
{
"id": 607,
"campaign_title": "Melyssa McKenzie IV",
"campaign_text": "Et deserunt nostrum est qui labore fugit ut. Et aut qui praesentium animi. Magni praesentium et reiciendis quo minima qui non nihil. Sunt rerum illo reprehenderit ut.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWZmP3RleHQ9b2ZmaWNpYQ==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWZmP3RleHQ9b2ZmaWNpYQ==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWZmP3RleHQ9b2ZmaWNpYQ==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWZmP3RleHQ9b2ZmaWNpYQ=="
},
"store_id": 1771,
"token": "o8rdpzqjgz57usyx",
"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": 608,
"campaign_title": "Giovani O'Connell",
"campaign_text": "Cumque ratione placeat aut aut excepturi tempore et. Modi veritatis dolorem non molestias. Quisquam ad ullam optio aspernatur sed. Iusto aut est at aut sequi voluptates minima.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZW9z",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZW9z",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZW9z",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmFhP3RleHQ9ZW9z"
},
"store_id": 1772,
"token": "ioxxolm0fsv4rpn7",
"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": 609,
"campaign_title": "Mason Runte",
"campaign_text": "Omnis ipsum doloremque repellat quia esse velit velit. Non maiores molestias eligendi eum. Qui hic vitae ab aut suscipit placeat maiores quam.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZGVlP3RleHQ9cXVpYQ==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZGVlP3RleHQ9cXVpYQ==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZGVlP3RleHQ9cXVpYQ==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZGVlP3RleHQ9cXVpYQ=="
},
"store_id": 1773,
"token": "kly2dnz1dal6n7y6",
"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\": \"2002-12-05\",
\"end_date\": \"2077-07-09\"
}"
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/14/offers" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"have_received\",
\"name\": \"zjavqmeikqodvbg\"
}"
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/quia" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 621,
"campaign_title": "Ms. Libby Lemke V",
"campaign_text": "Non est cum non neque aut. Eaque eius tempora aliquam. Facilis aut cum debitis veritatis alias. Sed sapiente alias recusandae similique maxime voluptate. Sint error dolore saepe in.",
"has_product_seeding": false,
"has_onetime_payment": false,
"status": "active",
"image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA0NDAwP3RleHQ9dm9sdXB0YXRlbQ==",
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA0NDAwP3RleHQ9dm9sdXB0YXRlbQ==",
"url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA0NDAwP3RleHQ9dm9sdXB0YXRlbQ==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA0NDAwP3RleHQ9dm9sdXB0YXRlbQ=="
},
"store_id": 1808,
"store_name": "Friesen and Sons",
"store_logo_url": null,
"store_logo": null,
"currency": "USD",
"token": "3a9vgptmnz6zl5q3",
"traffic_sources_costs": [
{
"id": 202,
"source": 0,
"source_name": "General",
"cpc": 1,
"cpc_v2": {
"amount": "0.01",
"currency": "USD"
},
"cpa": 0.04,
"currency": "USD"
}
],
"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\": [
19
],
\"user_tag_ids\": [
10
],
\"store_group_ids\": [
10
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"zfgovbqfgbxmnhnx\"
],
\"client_ids\": [
19
],
\"revenue_tier_ids\": [
5
]
}"
The ID of the offer.
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/13/users/10" \
--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/17/participants" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"query\": \"utzla\",
\"status\": \"store_denied\"
}"
{
"data": [
{
"id": null,
"offer_id": 611,
"user_id": null,
"display_name": "[email protected]",
"clicks": 19438001,
"status": "second_prio",
"pre_registered_email": "[email protected]",
"todo": null,
"payment_amount": null
},
{
"id": null,
"offer_id": 613,
"user_id": 3014,
"display_name": null,
"clicks": 24780,
"status": "second_prio",
"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/5/participants/6" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": null,
"offer_id": 614,
"user_id": 3017,
"display_name": "[email protected]",
"clicks": 175,
"status": "applied",
"todo": null,
"payment_amount": null,
"social_media": [],
"tags": [
{
"id": 132,
"name": "Miss Maud Denesik",
"slug": "vero-est-modi",
"access_level": 1,
"store_id": 1779
}
]
}
The ID of the offer.
curl --request GET \
--get "https://api.metapic.dev/v2/offers/16/participants-stats" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"query\": \"lvptfevzorsz\",
\"active\": true,
\"start_date\": \"2003-07-01\",
\"end_date\": \"2069-07-30\",
\"sort_by\": \"links_created:asc\"
}"
{
"data": [
{
"id": null,
"user_id": null,
"display_name": "[email protected]",
"clicks": 7041903,
"status": "open",
"links_created": null,
"estimated_gp": null,
"estimated_earning_to_cost_ratio": null
},
{
"id": null,
"user_id": null,
"display_name": "leffler.maybelle",
"clicks": 61120,
"status": "product_sent",
"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/13/participants-count-by-click-activity" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"start_date\": \"2011-07-07\",
\"end_date\": \"2121-10-05\"
}"
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/2/update-status" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"status\": \"applied\"
}"
{
"id": null,
"offer_id": 617,
"user_id": null,
"display_name": "[email protected]",
"clicks": 9741,
"status": "denied",
"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/2/participants/3/todo" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"todo\": [
{
\"key\": \"xcwxlvfebfhssmboxdtdxlv\",
\"value\": false
}
]
}"
{
"id": null,
"offer_id": 618,
"user_id": null,
"display_name": "kunde.damon",
"clicks": 36596013,
"status": "store_denied",
"pre_registered_identifier": "kunde.damon",
"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/15/overrides/clicks" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"click_limit\": 8
}"
{
"id": null,
"offer_id": 619,
"user_id": null,
"display_name": "shaun77",
"clicks": 2,
"status": "store_denied",
"pre_registered_identifier": "shaun77",
"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/8/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": 620,
"user_id": null,
"display_name": "leslie.stiedemann",
"clicks": 9721716,
"status": "have_posted",
"pre_registered_identifier": "leslie.stiedemann",
"todo": null,
"payment_amount": null
}
The ID of the user.
curl --request GET \
--get "https://api.metapic.dev/v2/offer-by-token/voluptas/users/1" \
--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=eyJpdiI6ImxrQ0lFd0wrQk5NenlVTnMrNS9URFE9PSIsInZhbHVlIjoiUjdKQjRxcDRZMFV0eWVOMTZaTVhRUDJiYnp0RHpOYU5ob2kySnV2aU5zZDJZSTZBMXIxRGdZOUc1bUcweUUrVUtyWFd1S3M2d0t2cXBUeTFmZ1VRcVJpQUJ6TzhBYmVGSDFvZWJud3hzQjRzVWRDRHZGZFdTL0JuSC9HS3FKWXkiLCJtYWMiOiJkZWJiOWI1YmFkYWNmMWZlZWUwZDc1Y2VkMDY3MTQyYjFhNjJjMmFmM2NlOWQ1MTUxZGNkNjRlMWE0YWQxNjJiIiwidGFnIjoiIn0%3D; expires=Tue, 01 Apr 2025 13:27:59 GMT; Max-Age=7200; path=/; 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/neque/users/19/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\": \"dgzkaidinrdwac\"
}"
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/4" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"comment\": \"gayksodbto\"
}"
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/4" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request GET \
--get "https://api.metapic.dev/v2/offer-users/sunt/activities" \
--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."
}
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": "Nathanael Conroy",
"advertiser_group_id": 3753,
"affiliate_link": {
"id": 785,
"url": "http://www.mayer.info/veniam-in-aut-qui-ut-dolor-at-officia-dolorem",
"original_url": "http://satterfield.biz/quo-nostrum-deleniti-suscipit-libero-id-eaque-cum.html",
"mtpc_url": "https://c.mtpc.se/785",
"user_id": 3024,
"country": "BG",
"provider": "aqua",
"advertiser": {
"id": 1790,
"name": "Veum Group"
}
},
"author_id": 3025,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9YWI=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9YWI=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9YWI="
},
"starts_at": "2025-03-01 13:27:58",
"ends_at": "2025-05-01 13:27:58",
"stats": []
},
{
"id": 277,
"name": "Maxine Nikolaus",
"advertiser_group_id": 3756,
"affiliate_link": {
"id": 786,
"url": "http://www.kreiger.biz/consequuntur-ad-modi-consequuntur-sed",
"original_url": "http://www.wuckert.org/et-dolorem-maxime-similique-consequatur-autem",
"mtpc_url": "https://c.mtpc.se/786",
"user_id": 3026,
"country": "FJ",
"provider": "black",
"advertiser": {
"id": 1791,
"name": "Borer Group"
}
},
"author_id": 3027,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzY2P3RleHQ9Y29uc2VjdGV0dXI=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzY2P3RleHQ9Y29uc2VjdGV0dXI=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzY2P3RleHQ9Y29uc2VjdGV0dXI="
},
"starts_at": "2025-03-01 13:27:58",
"ends_at": "2025-05-01 13:27:58",
"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\": \"scpaurloujpor\",
\"advertiser_group_id\": 13,
\"advertiser_id\": 10,
\"return_link\": \"https:\\/\\/advertiser.com\",
\"display_for_all_advertisers\": true,
\"advertiser_ids\": [
16
],
\"advertiser_category_ids\": [
15
],
\"styles\": {
\"color\": \"#ffffff\"
},
\"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
\"starts_at\": \"2025-04-01T13:27:58\",
\"ends_at\": \"2122-04-10\",
\"click_limit\": 6,
\"view_limit\": 5
}"
{
"id": 278,
"name": "Marisol Hayes III",
"advertiser_group_id": 3759,
"affiliate_link": {
"id": 787,
"url": "https://zulauf.com/ut-perferendis-temporibus-doloremque-atque.html",
"original_url": "http://skiles.com/",
"mtpc_url": "https://c.mtpc.se/787",
"user_id": 3028,
"country": "FO",
"provider": "fuchsia",
"advertiser": {
"id": 1792,
"name": "Gusikowski Group"
}
},
"author_id": 3029,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmJiP3RleHQ9dXQ=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmJiP3RleHQ9dXQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmJiP3RleHQ9dXQ="
},
"starts_at": "2025-03-01 13:27:58",
"ends_at": "2025-05-01 13:27:58",
"stats": []
}
The ID of the return ad.
curl --request GET \
--get "https://api.metapic.dev/v2/return-ads/8" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 279,
"name": "Kristofer Schimmel V",
"advertiser_group_id": 3762,
"affiliate_link": {
"id": 788,
"url": "http://torphy.net/animi-est-nobis-quia-aut-delectus-similique",
"original_url": "http://www.feeney.com/",
"mtpc_url": "https://c.mtpc.se/788",
"user_id": 3030,
"country": "SG",
"provider": "maroon",
"advertiser": {
"id": 1793,
"name": "Lebsack PLC"
}
},
"author_id": 3031,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmZmP3RleHQ9bWluaW1h",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmZmP3RleHQ9bWluaW1h",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2NmZmP3RleHQ9bWluaW1h"
},
"starts_at": "2025-03-01 13:27:59",
"ends_at": "2025-05-01 13:27:59",
"stats": []
}
The ID of the return ad.
curl --request PUT \
"https://api.metapic.dev/v2/return-ads/5" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"kfgtbjyuusupnumnymr\",
\"return_link\": \"https:\\/\\/advertiser.com\",
\"display_for_all_advertisers\": false,
\"advertiser_ids\": [
13
],
\"advertiser_category_ids\": [
4
],
\"styles\": {
\"color\": \"#ffffff\"
},
\"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
\"starts_at\": \"2025-04-01T13:27:59\",
\"ends_at\": \"2120-08-06\",
\"click_limit\": 6,
\"view_limit\": 4
}"
{
"id": 280,
"name": "Ms. Dortha Hayes",
"advertiser_group_id": 3765,
"affiliate_link": {
"id": 789,
"url": "http://lemke.biz/repudiandae-saepe-temporibus-amet-deleniti",
"original_url": "http://www.roberts.com/aut-incidunt-repellendus-velit-non-recusandae-qui-adipisci",
"mtpc_url": "https://c.mtpc.se/789",
"user_id": 3032,
"country": "BA",
"provider": "silver",
"advertiser": {
"id": 1794,
"name": "Hessel, Conn and Feeney"
}
},
"author_id": 3033,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWNjP3RleHQ9bmVzY2l1bnQ=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWNjP3RleHQ9bmVzY2l1bnQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWNjP3RleHQ9bmVzY2l1bnQ="
},
"starts_at": "2025-03-01 13:27:59",
"ends_at": "2025-05-01 13:27:59",
"stats": []
}
The ID of the return ad.
curl --request DELETE \
"https://api.metapic.dev/v2/return-ads/10" \
--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/12/pause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 281,
"name": "Prof. Dominic Ortiz V",
"advertiser_group_id": 3768,
"affiliate_link": {
"id": 790,
"url": "http://www.streich.com/aut-est-laboriosam-ea-asperiores-ducimus-amet-dolor",
"original_url": "http://lubowitz.org/provident-repudiandae-eveniet-eligendi-quia-molestiae",
"mtpc_url": "https://c.mtpc.se/790",
"user_id": 3034,
"country": "CA",
"provider": "navy",
"advertiser": {
"id": 1795,
"name": "Jacobi-Morar"
}
},
"author_id": 3035,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9dGVuZXR1cg==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9dGVuZXR1cg==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9dGVuZXR1cg=="
},
"starts_at": "2025-03-01 13:27:59",
"ends_at": "2025-05-01 13:27:59",
"stats": []
}
The ID of the returnAd.
curl --request POST \
"https://api.metapic.dev/v2/return-ads/2/unpause" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 282,
"name": "Prof. Carmine Cremin",
"advertiser_group_id": 3771,
"affiliate_link": {
"id": 791,
"url": "http://oberbrunner.com/eius-et-perspiciatis-dolorum-sit-quisquam",
"original_url": "http://stark.com/harum-labore-similique-enim-quia",
"mtpc_url": "https://c.mtpc.se/791",
"user_id": 3036,
"country": "AT",
"provider": "aqua",
"advertiser": {
"id": 1796,
"name": "Ryan LLC"
}
},
"author_id": 3037,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDk5P3RleHQ9dmVsaXQ=",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDk5P3RleHQ9dmVsaXQ=",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDk5P3RleHQ9dmVsaXQ="
},
"starts_at": "2025-03-01 13:27:59",
"ends_at": "2025-05-01 13:27:59",
"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/16/return-ads" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 283,
"name": "Zula Boehm",
"advertiser_group_id": 3774,
"affiliate_link": {
"id": 792,
"url": "http://www.davis.com/quisquam-nam-sed-sed-eligendi-necessitatibus-ut-accusamus",
"original_url": "http://www.mann.com/consequatur-repellat-dolore-doloribus-vel-et-vitae-et-qui",
"mtpc_url": "https://c.mtpc.se/792",
"user_id": 3038,
"country": "FM",
"provider": "fuchsia",
"advertiser": {
"id": 1797,
"name": "Moore, Will and Bradtke"
}
},
"author_id": 3039,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OWNjP3RleHQ9ZXN0",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OWNjP3RleHQ9ZXN0",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OWNjP3RleHQ9ZXN0"
},
"starts_at": "2025-03-01 13:27:59",
"ends_at": "2025-05-01 13:27:59",
"stats": []
},
{
"id": 284,
"name": "Mr. Kurtis Fritsch DDS",
"advertiser_group_id": 3777,
"affiliate_link": {
"id": 793,
"url": "http://www.schaden.biz/corrupti-occaecati-numquam-praesentium-dolor-dolores-et",
"original_url": "http://www.hauck.info/",
"mtpc_url": "https://c.mtpc.se/793",
"user_id": 3040,
"country": "SY",
"provider": "purple",
"advertiser": {
"id": 1798,
"name": "Jerde-Cole"
}
},
"author_id": 3041,
"display_for_all_advertisers": false,
"status": "active",
"styles": null,
"image": {
"key": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjMzP3RleHQ9ZGlzdGluY3Rpbw==",
"url": "https://media.metapic.com/insecure/rs:fit:2000:2000/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjMzP3RleHQ9ZGlzdGluY3Rpbw==",
"base_url": "https://media.metapic.com",
"base64": "dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjMzP3RleHQ9ZGlzdGluY3Rpbw=="
},
"starts_at": "2025-03-01 13:27:59",
"ends_at": "2025-05-01 13:27:59",
"stats": []
}
]
List Shared Budgets for Store
The ID of the store.
curl --request GET \
--get "https://api.metapic.dev/v2/stores/6/shared-budgets" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
[
{
"id": 41,
"title": "Marjolaine Haley",
"amount": 9,
"consumed_budget": 0,
"currency": "USD"
},
{
"id": 42,
"title": "Ana Hahn",
"amount": 8,
"consumed_budget": 0,
"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/19/shared-budgets/1" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 43,
"title": "Prof. Kay Gibson MD",
"amount": 8,
"consumed_budget": 0,
"currency": "PLN"
}
Updates existing budget.
The ID of the store.
The ID of the shared budget.
curl --request PUT \
"https://api.metapic.dev/v2/stores/9/shared-budgets/8" \
--header "Authorization: {accessToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Summer budget\",
\"amount\": 10000
}"
{
"id": 44,
"title": "Bernard Walsh",
"amount": 9,
"consumed_budget": 0,
"currency": "GBP"
}
The ID of the store.
The ID of the shared budget.
curl --request DELETE \
"https://api.metapic.dev/v2/stores/1/shared-budgets/18" \
--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": 1801,
"name": "Langosh, Ebert and Carter"
},
{
"id": 1802,
"name": "Bechtelar-Bashirian"
}
],
"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\": [
4
],
\"logo_url\": \"http:\\/\\/www.olson.com\\/\",
\"country\": \" Example: SE\",
\"currency\": \"Example: EUR\",
\"language\": \"sv\",
\"billing\": {
\"company_name\": \"rerum\",
\"street\": \"ut\",
\"postal_code\": \"molestiae\",
\"city\": \"nisi\",
\"vat_number\": \"est\"
}
}"
{
"id": 1803,
"name": "Funk, Herzog and Shanahan"
}
The ID of the store.
curl --request PUT \
"https://api.metapic.dev/v2/stores/1/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\": \"consectetur\"
}"
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": 3044,
"username": "vtremblay",
"email": "[email protected]",
"client_id": 3151
},
{
"id": 3045,
"username": "istokes",
"email": "[email protected]",
"client_id": 3152
}
],
"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"