Introduction
This documentation aims to provide all the information you need to work with our API.
Authenticating requests
This API is not authenticated.
Clicks
Get Clicks By Date
requires authentication
Return the number of clicks. If is given user_id - connected to that user. Between the from and to dates if not given - for today.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/clicks/by-date/1';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'query' => [
'from' => '2014-11-08 10:24',
'to' => '2014-11-08 10:24',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/clicks/by-date/1?from=2014-11-08+10%3A24&to=2014-11-08+10%3A24" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/clicks/by-date/1"
);
const params = {
"from": "2014-11-08 10:24",
"to": "2014-11-08 10:24",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"{userEmail}": {
"day": [
{
"date": "2020-02-17",
"link_clicks": 262,
"tag_clicks": 0,
"user_id": 838,
"email": "{userEmail}"
},
"..."
],
"total": 58687
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Clicks
requires authentication
Return the number of clicks. Between the from and to dates if not given for today.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/clicks';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'query' => [
'from' => '2014-11-08 10:24',
'to' => '2014-11-08 10:24',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/clicks?from=2014-11-08+10%3A24&to=2014-11-08+10%3A24" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/clicks"
);
const params = {
"from": "2014-11-08 10:24",
"to": "2014-11-08 10:24",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
[
{
"email": "{userEmail}",
"tag_clicks": 0,
"link_clicks": 16259,
"total_clicks": 16259,
"user_revenue": 853070,
"client_revenue": 0,
"affiliate": 0,
"user_id": "{userId}",
"sum_sek": "15290",
"ut_user_id": 838
},
"..."
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get User Clicks
requires authentication
Return the number of clicks. If is given user_id - connected to that user. Between the from and to dates if not given - for today.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/clicks/1';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'query' => [
'from' => '2014-11-08 10:24',
'to' => '2014-11-08 10:24',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/clicks/1?from=2014-11-08+10%3A24&to=2014-11-08+10%3A24" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/clicks/1"
);
const params = {
"from": "2014-11-08 10:24",
"to": "2014-11-08 10:24",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"email": "{userEmail}",
"tag_clicks": 0,
"link_clicks": 16259,
"total_clicks": 16259,
"user_revenue": 853070,
"client_revenue": 0,
"affiliate": 0,
"user_id": "{userId}",
"sum_sek": "15290",
"ut_user_id": 838
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Deep linking
DeepLink BlogPost
requires authentication
Transform a html blocks links to metapic links. Will only transform links that you can earn money on
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/deepLinkBlogPost/1';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'blogPost' => '<div> <a href=\'https://na-kd.com\'> link</a></div>',
'dry' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/deepLinkBlogPost/1" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"blogPost\": \"<div> <a href=\'https:\\/\\/na-kd.com\'> link<\\/a><\\/div>\",
\"dry\": 1
}"
const url = new URL(
"https://api.metapic.com/deepLinkBlogPost/1"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"blogPost": "<div> <a href='https:\/\/na-kd.com'> link<\/a><\/div>",
"dry": 1
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"newHtml": "<div> <a href=\"https://c.mtpc.se/tags/link/2082970\"> link</a></div>",
"linkTranslation": [
{
"before": "https://na-kd.com",
"status": "success",
"store": "NA-KD",
"storeId": "{storeId}",
"type": "tradedoubler_SE",
"after": "https://c.mtpc.se/tags/link/2082970",
"currency": "SEK",
"tag_id": "{tagId}",
"user_revenue_cpc": 250,
"user_instagram_cpc": 100,
"user_revenue_cpa": 0,
"user_instagram_cpa": 0,
"user_revenue_cpc_formated": "2.50 kr",
"user_instagram_cpc_formated": "1.00 kr",
"traffic_sources_costs": [
{
"id": 301,
"store_id": "{storeId}",
"source": 0,
"cpc": 250,
"invoice_cpc": 250,
"cpa": 0,
"invoice_cpa": null,
"created_at": "2023-05-03 12:01:08",
"updated_at": "2023-05-03 12:01:08",
"user_revenue": 1,
"client_revenue": null,
"cpc_formatted": "2.50 kr",
"title": "General"
},
{
"id": 302,
"store_id": "{storeId}",
"source": 1,
"cpc": 100,
"invoice_cpc": 100,
"cpa": null,
"invoice_cpa": null,
"created_at": "2023-05-03 12:01:09",
"updated_at": "2023-05-03 12:01:09",
"user_revenue": 1,
"client_revenue": null,
"cpc_formatted": "1.00 kr",
"title": "Instagram"
}
]
}
],
"isUpdated": true
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create Deep Links
requires authentication
Create deeplinks from an array of links
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/deep-links';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'links' => '["https://ellos.com"]',
'userId' => 1,
'dry' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/deep-links" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"links\": \"[\\\"https:\\/\\/ellos.com\\\"]\",
\"userId\": 1,
\"dry\": 1
}"
const url = new URL(
"https://api.metapic.com/deep-links"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"links": "[\"https:\/\/ellos.com\"]",
"userId": 1,
"dry": 1
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
[
{
"before": "https://na-kd.com",
"status": "success",
"store": "NA-KD",
"storeId": "{storeId}",
"type": "tradedoubler_SE",
"after": "https://c.mtpc.se/tags/link/2082974",
"currency": "SEK",
"tag_id": "{tagId}",
"user_revenue_cpc": 250,
"user_instagram_cpc": 100,
"user_revenue_cpa": 0,
"user_instagram_cpa": 0,
"user_revenue_cpc_formated": "2.50 kr",
"user_instagram_cpc_formated": "1.00 kr",
"traffic_sources_costs": [
{
"id": 301,
"store_id": "{storeId}",
"source": 0,
"cpc": 250,
"invoice_cpc": 250,
"cpa": 0,
"invoice_cpa": null,
"created_at": "2023-05-03 12:01:08",
"updated_at": "2023-05-03 12:01:08",
"user_revenue": 1,
"client_revenue": null,
"cpc_formatted": "2.50 kr",
"title": "General"
},
{
"id": 302,
"store_id": "{storeId}",
"source": 1,
"cpc": 100,
"invoice_cpc": 100,
"cpa": null,
"invoice_cpa": null,
"created_at": "2023-05-03 12:01:09",
"updated_at": "2023-05-03 12:01:09",
"user_revenue": 1,
"client_revenue": null,
"cpc_formatted": "1.00 kr",
"title": "Instagram"
}
]
},
"..."
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Endpoints
Display a listing of the resource.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/stores/{store_id}/offers';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/stores/{store_id}/offers" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/stores/{store_id}/offers"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get the validation rules that apply to the request.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/stores/{store_id}/offers';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'active' => false,
'campaign_title' => 'twdariyixmykjadwtoy',
'campaign_text' => 'hbyqjqgervwgiqgxhaakzkoql',
'has_product_seeding' => true,
'todo' => [
'voluptatem',
],
'has_onetime_payment' => false,
'one_time_payment' => 24,
'valid_from' => '2024-04-25T13:45:43',
'valid_until' => '1987-04-10',
'max_clicks' => 23,
'per_user_limit' => true,
'max_money' => 12,
'type' => 'standard',
'traffic_sources_costs' => [
'magnam',
],
'targets' => [
'user_ids' => [
17,
],
'user_tag_ids' => [
7,
],
'store_group_ids' => [
13,
],
'emails' => [
'[email protected]',
],
'social_media_identifiers' => [
'ysevnoajyokcx',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/v2/stores/{store_id}/offers" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"active\": false,
\"campaign_title\": \"twdariyixmykjadwtoy\",
\"campaign_text\": \"hbyqjqgervwgiqgxhaakzkoql\",
\"has_product_seeding\": true,
\"todo\": [
\"voluptatem\"
],
\"has_onetime_payment\": false,
\"one_time_payment\": 24,
\"valid_from\": \"2024-04-25T13:45:43\",
\"valid_until\": \"1987-04-10\",
\"max_clicks\": 23,
\"per_user_limit\": true,
\"max_money\": 12,
\"type\": \"standard\",
\"traffic_sources_costs\": [
\"magnam\"
],
\"targets\": {
\"user_ids\": [
17
],
\"user_tag_ids\": [
7
],
\"store_group_ids\": [
13
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"ysevnoajyokcx\"
]
}
}"
const url = new URL(
"https://api.metapic.com/v2/stores/{store_id}/offers"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"active": false,
"campaign_title": "twdariyixmykjadwtoy",
"campaign_text": "hbyqjqgervwgiqgxhaakzkoql",
"has_product_seeding": true,
"todo": [
"voluptatem"
],
"has_onetime_payment": false,
"one_time_payment": 24,
"valid_from": "2024-04-25T13:45:43",
"valid_until": "1987-04-10",
"max_clicks": 23,
"per_user_limit": true,
"max_money": 12,
"type": "standard",
"traffic_sources_costs": [
"magnam"
],
"targets": {
"user_ids": [
17
],
"user_tag_ids": [
7
],
"store_group_ids": [
13
],
"emails": [
"[email protected]"
],
"social_media_identifiers": [
"ysevnoajyokcx"
]
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get the validation rules that apply to the request.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{id}';
$response = $client->put(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'active' => true,
'campaign_title' => 'ihvewonqz',
'campaign_text' => 'thjfnidlvnglkjjdgmq',
'has_product_seeding' => false,
'todo' => [
'placeat',
],
'has_onetime_payment' => false,
'one_time_payment' => 14,
'valid_from' => '2024-04-25T13:45:43',
'valid_until' => '2070-04-01',
'max_clicks' => 17,
'per_user_limit' => true,
'max_money' => 15,
'type' => 'user_accept',
'traffic_sources_costs' => [
'aliquam',
],
'targets' => [
'user_ids' => [
1,
],
'user_tag_ids' => [
9,
],
'store_group_ids' => [
9,
],
'emails' => [
'[email protected]',
],
'social_media_identifiers' => [
'ymwqhpjzzkkmurso',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.metapic.com/v2/offers/{id}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"active\": true,
\"campaign_title\": \"ihvewonqz\",
\"campaign_text\": \"thjfnidlvnglkjjdgmq\",
\"has_product_seeding\": false,
\"todo\": [
\"placeat\"
],
\"has_onetime_payment\": false,
\"one_time_payment\": 14,
\"valid_from\": \"2024-04-25T13:45:43\",
\"valid_until\": \"2070-04-01\",
\"max_clicks\": 17,
\"per_user_limit\": true,
\"max_money\": 15,
\"type\": \"user_accept\",
\"traffic_sources_costs\": [
\"aliquam\"
],
\"targets\": {
\"user_ids\": [
1
],
\"user_tag_ids\": [
9
],
\"store_group_ids\": [
9
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"ymwqhpjzzkkmurso\"
]
}
}"
const url = new URL(
"https://api.metapic.com/v2/offers/{id}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"active": true,
"campaign_title": "ihvewonqz",
"campaign_text": "thjfnidlvnglkjjdgmq",
"has_product_seeding": false,
"todo": [
"placeat"
],
"has_onetime_payment": false,
"one_time_payment": 14,
"valid_from": "2024-04-25T13:45:43",
"valid_until": "2070-04-01",
"max_clicks": 17,
"per_user_limit": true,
"max_money": 15,
"type": "user_accept",
"traffic_sources_costs": [
"aliquam"
],
"targets": {
"user_ids": [
1
],
"user_tag_ids": [
9
],
"store_group_ids": [
9
],
"emails": [
"[email protected]"
],
"social_media_identifiers": [
"ymwqhpjzzkkmurso"
]
}
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove the specified resource from storage.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{id}';
$response = $client->delete(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.metapic.com/v2/offers/{id}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offers/{id}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Display a listing of the resource.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}/targets';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offers/{offer_id}/targets" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}/targets"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get the validation rules that apply to the request.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}/targets';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'user_ids' => [
12,
],
'user_tag_ids' => [
5,
],
'store_group_ids' => [
13,
],
'emails' => [
'[email protected]',
],
'social_media_identifiers' => [
'sqfqmssjbhycodfuh',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/v2/offers/{offer_id}/targets" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"user_ids\": [
12
],
\"user_tag_ids\": [
5
],
\"store_group_ids\": [
13
],
\"emails\": [
\"[email protected]\"
],
\"social_media_identifiers\": [
\"sqfqmssjbhycodfuh\"
]
}"
const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}/targets"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"user_ids": [
12
],
"user_tag_ids": [
5
],
"store_group_ids": [
13
],
"emails": [
"[email protected]"
],
"social_media_identifiers": [
"sqfqmssjbhycodfuh"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Display the specified resource.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}/targets/{id}';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offers/{offer_id}/targets/{id}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}/targets/{id}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update the specified resource in storage.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}/targets/{id}';
$response = $client->put(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.metapic.com/v2/offers/{offer_id}/targets/{id}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}/targets/{id}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove the specified resource from storage.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}/targets/{id}';
$response = $client->delete(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.metapic.com/v2/offers/{offer_id}/targets/{id}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}/targets/{id}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Say Hello to World
requires authentication
Returns a hello message with the arguments that you send in
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/hello';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/hello" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/hello"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"message": "hello world",
"input": {
"access_token": "OYqOixgvEbxc9nnKiZCywzDkZHNpKRP8",
"client_id": "591571223752267"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Client organization invoice payment Pdf
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/clients/{clientId}/invoices/{invoiceId}/pdf';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/clients/{clientId}/invoices/{invoiceId}/pdf" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/clients/{clientId}/invoices/{invoiceId}/pdf"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Client organization invoice payment excel
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/clients/{clientId}/invoices/{invoiceId}/excel';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/clients/{clientId}/invoices/{invoiceId}/excel" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/clients/{clientId}/invoices/{invoiceId}/excel"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Check Agency
requires authentication
Returns agency name
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/clients/check';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/clients/check" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/clients/check"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get user access token by email (only for default zezam client)
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/access-token/from-email';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'email' => 'voluptatem',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/users/access-token/from-email" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"email\": \"voluptatem\"
}"
const url = new URL(
"https://api.metapic.com/users/access-token/from-email"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"email": "voluptatem"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get user access token by userId (only for default zezam client)
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/access-token/from-id';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'userId' => 15,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/users/access-token/from-id" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"userId\": 15
}"
const url = new URL(
"https://api.metapic.com/users/access-token/from-id"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"userId": 15
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PUT v2/stores/{store_id}/payment
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/stores/{store_id}/payment';
$response = $client->put(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.metapic.com/v2/stores/{store_id}/payment" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/stores/{store_id}/payment"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Checks if user has been added to the offer.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offer-by-token/{offer_token}/users/{userId}';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offer-by-token/{offer_token}/users/{userId}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offer-by-token/{offer_token}/users/{userId}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Offer User Activity
Get the list of activities on OfferUser card
requires authentication
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offer-users/{offerUser_id}/activities';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offer-users/{offerUser_id}/activities" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offer-users/{offerUser_id}/activities"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"data": [
{
"type": "COMMENT",
"actor_id": 34985,
"actor_display_name": "@username",
"comment_id": 1,
"comment_text": "Qui delectus provident labore iusto aut ad aperiam. Vitae recusandae quis laborum culpa placeat animi quibusdam. Cum omnis quas velit rerum blanditiis voluptas modi provident.",
"created_at": "2024-04-16T22:39:26"
},
{
"type": "COMMENT",
"actor_id": 40185,
"actor_display_name": "Mark",
"comment_id": 1,
"comment_text": "Cum a maxime sit rem tenetur. Ad in quibusdam suscipit est eos aut. Ex eligendi necessitatibus tempora distinctio.",
"created_at": "2024-04-16T22:39:26",
"updated_at": "2024-04-16T22:39:26"
},
{
"type": "DELETED_COMMENT",
"created_at": "2024-04-16CEST22:15:41"
},
{
"type": "STATUS_CHANGE",
"actor_id": 40185,
"actor_display_name": "Admin",
"old_status": "suggestion",
"new_status": "denied",
"created_at": "2024-04-16T22:39:26"
},
{
"type": "STATUS_CHANGE",
"old_status": "applied",
"new_status": "have_posted",
"created_at": "2024-04-16T22:42:35"
},
{
"type": "STATUS_CHANGE",
"actor_id": 34985,
"actor_display_name": "@username",
"old_status": "applied",
"new_status": "accepted",
"created_at": "2024-04-16T22:44:59"
}
],
"links": {
"first": "/v2/offer-users/48798908/activities?page=1",
"last": "/v2/offer-users/48798908/activities?page=10",
"prev": null,
"next": "/v2/offer-users/48798908/activities?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 10,
"links": [],
"path": "/v2/offer-users/48798908/activities",
"per_page": 20,
"to": 20,
"total": 200
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
type
string
The type of the activity. Can be one of the following values:
- COMMENT
- DELETED_COMMENT
- STATUS_CHANGE
actor_id
integer
Unique identifier of the user who initiated the activity.
Absent when the activity was caused by the system.
actor_display_name
string
The name of the actor who initiated the activity.
In case of Creator contains username
In case of Admin or Advertiser contains the full name
Absent when the activity was caused by the system.
comment_id
integer
Unique identifier of the comment.
Present when type is COMMENT
comment_text
string
Contains the comment text.
Present when type is COMMENT
new_status
string
New offerUser status
Present when type is STATUS_CHANGE
old_status
string
Old offerUser status
Present when type is STATUS_CHANGE
created_at
string
Indicates time at which the activity happened.
updated_at
string
Time of last editing.
Present if comment was edited
Get the list of DUMMY activities
requires authentication
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offer-users/{offerUser_id}/activities/dummy';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offer-users/{offerUser_id}/activities/dummy" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offer-users/{offerUser_id}/activities/dummy"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"data": [
{
"type": "COMMENT",
"actor_id": 34985,
"actor_display_name": "@username",
"comment_id": 1,
"comment_text": "Qui delectus provident labore iusto aut ad aperiam. Vitae recusandae quis laborum culpa placeat animi quibusdam. Cum omnis quas velit rerum blanditiis voluptas modi provident.",
"created_at": "2024-04-16T22:39:26"
},
{
"type": "COMMENT",
"actor_id": 40185,
"actor_display_name": "Mark",
"comment_id": 1,
"comment_text": "Cum a maxime sit rem tenetur. Ad in quibusdam suscipit est eos aut. Ex eligendi necessitatibus tempora distinctio.",
"created_at": "2024-04-16T22:39:26",
"updated_at": "2024-04-16T22:39:26"
},
{
"type": "DELETED_COMMENT",
"created_at": "2024-04-16CEST22:15:41"
},
{
"type": "STATUS_CHANGE",
"actor_id": 40185,
"actor_display_name": "Admin",
"old_status": "suggestion",
"new_status": "denied",
"created_at": "2024-04-16T22:39:26"
},
{
"type": "STATUS_CHANGE",
"old_status": "applied",
"new_status": "have_posted",
"created_at": "2024-04-16T22:42:35"
},
{
"type": "STATUS_CHANGE",
"actor_id": 34985,
"actor_display_name": "@username",
"old_status": "applied",
"new_status": "accepted",
"created_at": "2024-04-16T22:44:59"
}
],
"links": {
"first": "/v2/offer-users/48798908/activities?page=1",
"last": "/v2/offer-users/48798908/activities?page=10",
"prev": null,
"next": "/v2/offer-users/48798908/activities?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 10,
"links": [],
"path": "/v2/offer-users/48798908/activities",
"per_page": 20,
"to": 20,
"total": 200
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
type
string
The type of the activity. Can be one of the following values:
- COMMENT
- DELETED_COMMENT
- STATUS_CHANGE
actor_id
integer
Unique identifier of the user who initiated the activity.
Absent when the activity was caused by the system.
actor_display_name
string
The name of the actor who initiated the activity.
In case of Creator contains username
In case of Admin or Advertiser contains the full name
Absent when the activity was caused by the system.
comment_id
integer
Unique identifier of the comment.
Present when type is COMMENT
comment_text
string
Contains the comment text.
Present when type is COMMENT
new_status
string
New offerUser status
Present when type is STATUS_CHANGE
old_status
string
Old offerUser status
Present when type is STATUS_CHANGE
created_at
string
Indicates time at which the activity happened.
updated_at
string
Time of last editing.
Present if comment was edited
Offers
Get offer
requires authentication
Return offer details.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offers/{offer_id}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Upload Offer Image (v2)
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offers/{offer_id}/uploads';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'default' => 'image.png',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/v2/offers/{offer_id}/uploads" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"default\": \"image.png\"
}"
const url = new URL(
"https://api.metapic.com/v2/offers/{offer_id}/uploads"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"default": "image.png"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get offer
requires authentication
Return offer details.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offer-by-token/{offer_token}';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/v2/offer-by-token/{offer_token}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offer-by-token/{offer_token}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Mark user as having joined the campaign
requires authentication
This can only be performed by the user themselves.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/offer-by-token/{offer_token}/users/{user_id}/join';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/v2/offer-by-token/{offer_token}/users/{user_id}/join" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/v2/offer-by-token/{offer_token}/users/{user_id}/join"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Payment
Get list of all invoices.
requires authentication
Here you get a list of all invoices to this client. See Get Payment for invoice for getting more info about a invoice.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/client/{clientId}/paymentsInvoice';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/client/{clientId}/paymentsInvoice" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/client/{clientId}/paymentsInvoice"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
[
{
"id": 123,
"payment_date": "2020-07-01 00:00:00",
"sent_to_partner_at": "2020-07-05 00:00:00",
"updated_at": "2019-11-12 10:13:50",
"created_at": "2019-11-12 10:13:50"
},
"..."
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get payments for last month
requires authentication
Will give you all payments for last month. this is not final before 3 working days after last day of month before.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/client/{clientId}/paymentsInvoice/lastMonth';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/client/{clientId}/paymentsInvoice/lastMonth" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/client/{clientId}/paymentsInvoice/lastMonth"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
[
{
"id": 132424,
"user_id": 123,
"email": "[email protected]",
"user_earnings": 12345,
"accepted_at": "2020-09-03 14:50:03",
"client_earnings": 1235,
"currency": "SEK",
"user_earnings_formatted": "123.45 kr",
"client_earnings_formatted": "12.35 kr"
},
"..."
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get payments for this month
requires authentication
Will give you all payments for current month. this is not final before 3 working days after last day of month.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/client/{clientId}/paymentsInvoice/thisMonth';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/client/{clientId}/paymentsInvoice/thisMonth" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/client/{clientId}/paymentsInvoice/thisMonth"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
[
{
"id": 132424,
"user_id": 123,
"email": "[email protected]",
"user_earnings": 12345,
"accepted_at": "2020-09-03 14:50:03",
"client_earnings": 1235,
"currency": "SEK",
"user_earnings_formatted": "123.45 kr",
"client_earnings_formatted": "12.35 kr"
},
"..."
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Social Media
Get Social Media
requires authentication
Returns all user's social media connected to your client account, sorted id in asc order.
Create Social Media
requires authentication
Create a new social media for user. Return social media as a json object.
Get Social Media by ID
requires authentication
Fetches social media based on social media id and user id.
Update Social Media
requires authentication
Update user's social media. Return the modified social media as a json object.
Delete Social Media
requires authentication
Delete user's social media.
Store
Create Store
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/v2/stores';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'name' => 'voluptatem',
'domains' => [
'BQ.tZqpzb',
],
'categories' => [
1,
],
'logo_url' => 'http://reilly.net/nisi-minus-eveniet-possimus-neque-natus-at-temporibus',
'country' => 'SE',
'currency' => 'EUR',
'language' => 'consequatur',
'billing' => [
'company_name' => 'blanditiis',
'street' => 'similique',
'postal_code' => 'ut',
'city' => 'doloremque',
'vat_number' => 'quo',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/v2/stores" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"name\": \"voluptatem\",
\"domains\": [
\"BQ.tZqpzb\"
],
\"categories\": [
1
],
\"logo_url\": \"http:\\/\\/reilly.net\\/nisi-minus-eveniet-possimus-neque-natus-at-temporibus\",
\"country\": \"SE\",
\"currency\": \"EUR\",
\"language\": \"consequatur\",
\"billing\": {
\"company_name\": \"blanditiis\",
\"street\": \"similique\",
\"postal_code\": \"ut\",
\"city\": \"doloremque\",
\"vat_number\": \"quo\"
}
}"
const url = new URL(
"https://api.metapic.com/v2/stores"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"name": "voluptatem",
"domains": [
"BQ.tZqpzb"
],
"categories": [
1
],
"logo_url": "http:\/\/reilly.net\/nisi-minus-eveniet-possimus-neque-natus-at-temporibus",
"country": "SE",
"currency": "EUR",
"language": "consequatur",
"billing": {
"company_name": "blanditiis",
"street": "similique",
"postal_code": "ut",
"city": "doloremque",
"vat_number": "quo"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Users
Access Token
requires authentication
Get User Access Token
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/1/access-token';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/users/1/access-token" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/users/1/access-token"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"random_token": "$2y$10$GqXBc.ciJ0qSZQrBJ5X8h.yxsnHs3R8cU6F1MlhhvtfEQAL6Do6yc",
"token": "$2y$10$GqXBc.ciJ0qSZQrBJ5X8h.yxsnHs3R8cU6F1MlhhvtfEQAL6Do6yc"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User Config
requires authentication
Get User Config
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/1/user-config';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/users/1/user-config" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/users/1/user-config"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"showedPopups": [
"firstCollageItem",
"linkTransform"
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GDPR Delete User
requires authentication
Delete user according to GDPR standards
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/1/gdpr-delete';
$response = $client->delete(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.metapic.com/users/1/gdpr-delete" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/users/1/gdpr-delete"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Example response (200):
{
"id": "{userId}",
"username": "",
"email": "",
"phone": "",
"created_at": "2021-11-10 12:04:16",
"updated_at": "2022-08-25 10:34:45",
"admin": 0,
"last_active": "0000-00-00 00:00:00",
"first_name": "",
"surname": "",
"vat_no": "",
"country": "",
"city": "",
"address": "",
"postcode": "",
"tier_pricing_type": "",
"config": null,
"sign_user_agreement": null,
"revenue_tier_id": "{revenue_tier_id}",
"recruitment_utm": null,
"is_suspended": false,
"is_verified": true
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Users
requires authentication
Returns all users connected to your client account, sorted on created date in descending order.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/users" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/users"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
[
{
"id": 1,
"created_at": "2018-11-17 22:24:28",
"updated_at": "2018-11-19 14:42:38",
"client_id": 2,
"revenue_share": "0.00",
"instagram_revenue_share": "0.00",
"name": "{username}"
},
"..."
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create User
requires authentication
Create a new Metapic user. The user will automatically be linked to your account.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users';
$response = $client->post(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'email' => '[email protected]',
'username' => 'testUser',
'password' => '123456',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request POST \
"https://api.metapic.com/users" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"email\": \"[email protected]\",
\"username\": \"testUser\",
\"password\": \"123456\"
}"
const url = new URL(
"https://api.metapic.com/users"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"email": "[email protected]",
"username": "testUser",
"password": "123456"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"id": "{userId}",
"username": "{username}",
"email": "{email}",
"created_at": "2019-06-17 11:53:17",
"updated_at": "2019-08-20 07:07:50",
"admin": 1,
"last_active": "0000-00-00 00:00:00",
"first_name": "{userName}",
"surname": "{userSurname}",
"country": "{country}",
"city": "{city}",
"address": "{address}",
"postcode": "{postcode}",
"tier_pricing_type": "",
"config": "{\"showedPopups\":[\"firstCollageItem\"]}",
"sign_user_agreement": "2019-08-14 08:34:12",
"revenue_tier_id": 105,
"recruitment_utm": null,
"is_suspended": false,
"is_verified": false,
"client": {
"id": 2,
"client_id": "{clientId}",
"name": "{clientName}",
"created_at": "2014-04-24 16:12:29",
"updated_at": "2018-11-21 13:57:23",
"own_paymentsystem": 0,
"config": "{ \"tabs\": { \"home\":{\"showMenu\":true}, \"find\":{\"showMenu\":true},\t\"collage\":{\"showMenu\":true},\t\"tagEditor\":{\"showMenu\":true}, \"stats\":{\"showMenu\":true},\t\"listLinks\":{\"showMenu\":true} }, \"canLogin\": true}",
"feed": "live_se",
"locale": "SE",
"revenue_model": "blog_percentage",
"revenue_share": "0.00",
"store_group_id": 1,
"default_revenue_tier": 81,
"default_verified_users": 0,
"store_group": {
"id": 1,
"name": "Standard SE",
"shopello": 1,
"key": "se",
"locale": "SE",
"lang": "sv",
"currency": "SEK",
"es": 0,
"payment_limit": 100000
}
},
"revenue_tier": {
"id": 76,
"created_at": "2018-09-14 16:39:34",
"updated_at": "2019-04-29 10:47:34",
"client_id": 2,
"revenue_share": "0.50",
"instagram_revenue_share": "0.10",
"name": "Silver"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get User
requires authentication
Fetches a user based on user id.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/1';
$response = $client->get(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request GET \
--get "https://api.metapic.com/users/1" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}"const url = new URL(
"https://api.metapic.com/users/1"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Example response (200):
{
"id": "{userId}",
"username": "{username}",
"email": "{email}",
"created_at": "2019-06-17 11:53:17",
"updated_at": "2019-08-20 07:07:50",
"admin": 1,
"last_active": "0000-00-00 00:00:00",
"first_name": "{userName}",
"surname": "{userSurname}",
"country": "{country}",
"city": "{city}",
"address": "{address}",
"postcode": "{postcode}",
"tier_pricing_type": "",
"config": "{\"showedPopups\":[\"firstCollageItem\"]}",
"sign_user_agreement": "2019-08-14 08:34:12",
"revenue_tier_id": 105,
"recruitment_utm": null,
"is_suspended": false,
"is_verified": false,
"client": {
"id": 2,
"client_id": "{clientId}",
"name": "{clientName}",
"created_at": "2014-04-24 16:12:29",
"updated_at": "2018-11-21 13:57:23",
"own_paymentsystem": 0,
"config": "{ \"tabs\": { \"home\":{\"showMenu\":true}, \"find\":{\"showMenu\":true},\t\"collage\":{\"showMenu\":true},\t\"tagEditor\":{\"showMenu\":true}, \"stats\":{\"showMenu\":true},\t\"listLinks\":{\"showMenu\":true} }, \"canLogin\": true}",
"feed": "live_se",
"locale": "SE",
"revenue_model": "blog_percentage",
"revenue_share": "0.00",
"store_group_id": 1,
"default_revenue_tier": 81,
"default_verified_users": 0,
"store_group": {
"id": 1,
"name": "Standard SE",
"shopello": 1,
"key": "se",
"locale": "SE",
"lang": "sv",
"currency": "SEK",
"es": 0,
"payment_limit": 100000
}
},
"revenue_tier": {
"id": 76,
"created_at": "2018-09-14 16:39:34",
"updated_at": "2019-04-29 10:47:34",
"client_id": 2,
"revenue_share": "0.50",
"instagram_revenue_share": "0.10",
"name": "Silver"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update User
requires authentication
Updates a Metapic user. Returns the modified user as a json object.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/1';
$response = $client->put(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'email' => '[email protected]',
'username' => 'testUser',
'password' => '123456',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request PUT \
"https://api.metapic.com/users/1" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"email\": \"[email protected]\",
\"username\": \"testUser\",
\"password\": \"123456\"
}"
const url = new URL(
"https://api.metapic.com/users/1"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"email": "[email protected]",
"username": "testUser",
"password": "123456"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"id": "{userId}",
"username": "{username}",
"email": "{email}",
"created_at": "2019-06-17 11:53:17",
"updated_at": "2019-08-20 07:07:50",
"admin": 1,
"last_active": "0000-00-00 00:00:00",
"first_name": "{userName}",
"surname": "{userSurname}",
"country": "{country}",
"city": "{city}",
"address": "{address}",
"postcode": "{postcode}",
"tier_pricing_type": "",
"config": "{\"showedPopups\":[\"firstCollageItem\"]}",
"sign_user_agreement": "2019-08-14 08:34:12",
"revenue_tier_id": 105,
"recruitment_utm": null,
"is_suspended": false,
"is_verified": false,
"client": {
"id": 2,
"client_id": "{clientId}",
"name": "{clientName}",
"created_at": "2014-04-24 16:12:29",
"updated_at": "2018-11-21 13:57:23",
"own_paymentsystem": 0,
"config": "{ \"tabs\": { \"home\":{\"showMenu\":true}, \"find\":{\"showMenu\":true},\t\"collage\":{\"showMenu\":true},\t\"tagEditor\":{\"showMenu\":true}, \"stats\":{\"showMenu\":true},\t\"listLinks\":{\"showMenu\":true} }, \"canLogin\": true}",
"feed": "live_se",
"locale": "SE",
"revenue_model": "blog_percentage",
"revenue_share": "0.00",
"store_group_id": 1,
"default_revenue_tier": 81,
"default_verified_users": 0,
"store_group": {
"id": 1,
"name": "Standard SE",
"shopello": 1,
"key": "se",
"locale": "SE",
"lang": "sv",
"currency": "SEK",
"es": 0,
"payment_limit": 100000
}
},
"revenue_tier": {
"id": 76,
"created_at": "2018-09-14 16:39:34",
"updated_at": "2019-04-29 10:47:34",
"client_id": 2,
"revenue_share": "0.50",
"instagram_revenue_share": "0.10",
"name": "Silver"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete User
requires authentication
Deletes a Metapic user. Returns the deleted user as json object.
Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.com/users/1';
$response = $client->delete(
$url,
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Authorization' => '{token}',
],
'json' => [
'force' => 4,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));curl --request DELETE \
"https://api.metapic.com/users/1" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: {token}" \
--data "{
\"force\": 4
}"
const url = new URL(
"https://api.metapic.com/users/1"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "{token}",
};
let body = {
"force": 4
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
{
"id": "{userId}",
"username": "{username}",
"email": "{email}",
"created_at": "2019-06-17 11:53:17",
"updated_at": "2019-08-20 07:07:50",
"admin": 1,
"last_active": "0000-00-00 00:00:00",
"first_name": "{userName}",
"surname": "{userSurname}",
"country": "{country}",
"city": "{city}",
"address": "{address}",
"postcode": "{postcode}",
"tier_pricing_type": "",
"config": "{\"showedPopups\":[\"firstCollageItem\"]}",
"sign_user_agreement": "2019-08-14 08:34:12",
"revenue_tier_id": 105,
"recruitment_utm": null,
"is_suspended": false,
"is_verified": false,
"client": {
"id": 2,
"client_id": "{clientId}",
"name": "{clientName}",
"created_at": "2014-04-24 16:12:29",
"updated_at": "2018-11-21 13:57:23",
"own_paymentsystem": 0,
"config": "{ \"tabs\": { \"home\":{\"showMenu\":true}, \"find\":{\"showMenu\":true},\t\"collage\":{\"showMenu\":true},\t\"tagEditor\":{\"showMenu\":true}, \"stats\":{\"showMenu\":true},\t\"listLinks\":{\"showMenu\":true} }, \"canLogin\": true}",
"feed": "live_se",
"locale": "SE",
"revenue_model": "blog_percentage",
"revenue_share": "0.00",
"store_group_id": 1,
"default_revenue_tier": 81,
"default_verified_users": 0,
"store_group": {
"id": 1,
"name": "Standard SE",
"shopello": 1,
"key": "se",
"locale": "SE",
"lang": "sv",
"currency": "SEK",
"es": 0,
"payment_limit": 100000
}
},
"revenue_tier": {
"id": 76,
"created_at": "2018-09-14 16:39:34",
"updated_at": "2019-04-29 10:47:34",
"client_id": 2,
"revenue_share": "0.50",
"instagram_revenue_share": "0.10",
"name": "Silver"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.