Metapic API docs

Introduction

Base URL: https://api.metapic.dev

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 👮

Authenticating requests

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.

Advertiser Groups

List advertiser groups

GET

https://api.metapic.dev

/v2/advertiser-groups

requires authentication

Endpoint for querying & sorting all advertiser groups.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

return_ad_enabled

boolean

Only return advertiser groups which have return ads enabled.

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

sort_by

string

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.

Example:

created_at:desc

Auth

Headers

Query Parameters

Received response

Example request:

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"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Rippin, Klein and Rowe",
            "key": "ar_IQ",
            "currency": "PLN"
        },
        {
            "id": null,
            "name": "Reichert Ltd",
            "key": "it_IT",
            "currency": "SEK"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Client

List clients

GET

https://api.metapic.dev

/v2/clients

requires authentication

Endpoint for querying & sorting all clients.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

name

string

Query by client's name or User revenue tier name. Returns all clients matching the given name. Must not be greater than 255 characters.

Example:

Metapic SE

store_group_id

integer

Query by client's store group. Returns all clients which belong to the given store_group_id.

Example:

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

sort_by

string

Example:

created_at:desc

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/clients?name=Metapic+SE&store_group_id=15&size=20&sort_by=created_at%3Adesc" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Dr. Lessie Williamson"
        },
        {
            "id": null,
            "name": "Torey Windler"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Creator Media

Operations on Media posted by Creators

Lists Creator generated media captured by Metapic.

GET

https://api.metapic.dev

/v2/user-media

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Filters media by username.

Example:

aut

status

string

Filter user media by show store value.

Must be one of:

all
0
1
2

Example:

type

string

Filters media by type.

Must be one of:

all
instagram
tiktok
youtube

Example:

instagram

favorite

string

Filter user media by favorite value.

Must be one of:

all
1
0

Example:

group

integer

:shrug:.

Example:

format

string

Format to export.

Must be one of:

csv
xlsx
json

Example:

csv

Response Fields

media_type

string

Describes the source of the media

Must be one of:

instagram
tiktok
youtube

media_id

string

Unique identifier of the video in YouTube.

Only present when media_type = 'youtube'.

Should be used for generating the URL for embedding the YouTube player, as described in https://developers.google.com/youtube/player_parameters

media

object

Describes the media for displaying on the page.

Only present when media_type is one of:

'instagram'
'tiktok'

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/user-media?query=aut&status=0&type=instagram&favorite=1&group=2&format=csv" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "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": "&laquo; 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 &raquo;",
            "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
}

Endpoints

Get Store Categories

GET

https://api.metapic.dev

/v2/store-categories

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Auth

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/store-categories" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[
    {
        "id": null,
        "name": "Food"
    },
    {
        "id": null,
        "name": "Books"
    }
]

GET v2/users/{user_id}/stores-by-categories

GET

https://api.metapic.dev

/v2/users/{user_id}/stores-by-categories

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/users/18/stores-by-categories" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

GET v2/users/{user_id}/stores-by-toplist

GET

https://api.metapic.dev

/v2/users/{user_id}/stores-by-toplist

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/users/17/stores-by-toplist" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Entrypoint

App's entrypoint

GET

https://api.metapic.dev

/v2/entrypoint

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

app

string

required

Must be one of:

advertiser
admin
agency
creator

Example:

creator

store_id

integer

This field is required when app is advertiser.

Example:

Response Fields

indicators

object

Auth

Headers

Body

{ "app": "creator", "store_id": 18 }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/entrypoint" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"app\": \"creator\",
    \"store_id\": 18
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Offer

Create campaign

POST

https://api.metapic.dev

/v2/stores/{store_id}/offers

requires authentication

Creates new campaign for a store.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The store ID.

Example:

Body Parameters

store_group_id

integer

required

Store group to which the campaign belongs to. Must be one of chosen store's store groups.

Example:

type

string

required

Type of the campaign.

Must be one of:

standard
user_accept
store_accept
suggestion

Example:

standard

name

string

required

Admin-only Internal name of the campaign, not visible to the creators and advertisers. Required when campaign_title is empty, otherwise it will default to the same value. Must not be greater than 255 characters.

Example:

Summer campaign for VIP creators

campaign_title

string

required

The title of the campaign, visible to the creators and advertisers. Required if type != "standard". Must not be greater than 255 characters.

Example:

Summer campaign

campaign_text

string

The description of the campaign, visible to the creators and advertisers. Must not be greater than 1056 characters.

Example:

This is a summer campaign!

has_product_seeding

boolean

required

Whether the campaign offers product seeding.

has_onetime_payment

boolean

required

Whether the campaign offers a fixed fee for creators.

per_user_limit

boolean

required

Whether the click limit is applied per creator or in total.

one_time_payment

number

The fixed fee amount, if applicable.

Example:

0.3623

budget_limit

integer

Specifies the campaign’s budget limit in minor units (e.g., cents). Can function independently of the shared budget.

Example:

max_clicks

integer

The click limit of a campaign.

Example:

valid_from

string

The start datetime of the campaign. Must be a valid date.

Example:

2025-01-10T11:10:59

valid_until

string

The end datetime of the campaign. Must be a valid date. Must be a date after from.

Example:

2021-04-18

todo

string[]

Must not be greater than 255 characters.

Example:

["owtvnaxne"]

store_visibility

string

Admin-only Toggle visibility of the store for the creators:

STORE_VISIBILITY_NONE = 0 -- do nothing, keep store visibility
STORE_VISIBILITY_HIDE = 1 -- hides store, even if store set to visible
STORE_VISIBILITY_SHOW = 2 -- shows store, even if store set to hidden

Must be one of:

Example:

show_for_advertiser

boolean

Admin-only Toggle campaign visibility in the advertiser-app.

priority_after

integer

Admin-only ID of the campaign with higher priority from the same advertiser, after which to add the new campaign. If null is passed, the new campaign will be added on top of all other campaigns (highest priority). If the property is not present at all, a default priority will be assigned which is below the lowest-priority campaign of type=standard from that advertiser (meant to be used in cases where a priority isn't explicitly chosen, like in advertiser-app).

Example:

traffic_sources_costs

object[]

Array of traffic sources costs applicable to the campaign.

source

integer

required

Source of the cost, e.g. Other (0), Instagram (1), TikTok (2).

Example:

cpc

integer

Cost per click amount, expressed in minor unit (e.g. cents).

Example:

230

cpa

number

Cost per action, expressed in percentage / 100. Must be between 0 and 1.

Example:

0.2

invoice_cpc

integer

Admin-only cpc amount, if advertiser is invoiced directly.

Example:

250

invoice_cpa

number

Admin-only cpa amount, if advertiser is invoiced directly. Must be between 0 and 1.

Example:

0.25

user_revenue

number

Must be between 0 and 1.

Example:

targets

object

Target audience of the campaign. Each target maps to a user which will be added to the campaign.

user_ids

integer[]

Example:

[7]

user_tag_ids

integer[]

Example:

[17]

store_group_ids

integer[]

Example:

[17]

emails

string[]

The value format is invalid.

Example:

["[email protected]"]

social_media_identifiers

string[]

Must not be greater than 30 characters.

Example:

["gvcwz"]

client_ids

integer[]

Example:

[8]

revenue_tier_ids

integer[]

Example:

[14]

shared_budget_id

string

Admin-only ID of the existing shared budget to assign to the campaign. If shared_budget_id is null campaign will be unassigned from shared budget.

Example:

shared_budget

object

Admin-only Object representing the shared budget to be created and assigned to the campaign. Prohibits shared_budget_id from being present.

Response Fields

warnings

object[]

Contains any warnings for creating campaign targets

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Body

{ "store_group_id": 14, "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": 0.3623, "budget_limit": 20, "max_clicks": 5, "valid_from": "2025-01-10T11:10:59", "valid_until": "2021-04-18", "todo": [ "owtvnaxne" ], "store_visibility": "0", "show_for_advertiser": false, "priority_after": 14, "traffic_sources_costs": [ { "source": 1, "cpc": 230, "cpa": 0.2, "invoice_cpc": 250, "invoice_cpa": 0.25, "user_revenue": 1 } ], "targets": { "user_ids": [ 7 ], "user_tag_ids": [ 17 ], "store_group_ids": [ 17 ], "emails": [ "[email protected]" ], "social_media_identifiers": [ "gvcwz" ], "client_ids": [ 8 ], "revenue_tier_ids": [ 14 ] }, "shared_budget_id": 1, "shared_budget": { "title": "Summer budget", "amount": 10000 } }

Received response

Example request:

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\": 14,
    \"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\": 0.3623,
    \"budget_limit\": 20,
    \"max_clicks\": 5,
    \"valid_from\": \"2025-01-10T11:10:59\",
    \"valid_until\": \"2021-04-18\",
    \"todo\": [
        \"owtvnaxne\"
    ],
    \"store_visibility\": \"0\",
    \"show_for_advertiser\": false,
    \"priority_after\": 14,
    \"shared_budget_id\": 1,
    \"shared_budget\": {
        \"title\": \"Summer budget\",
        \"amount\": 10000
    },
    \"targets\": {
        \"user_ids\": [
            7
        ],
        \"user_tag_ids\": [
            17
        ],
        \"store_group_ids\": [
            17
        ],
        \"emails\": [
            \"[email protected]\"
        ],
        \"social_media_identifiers\": [
            \"gvcwz\"
        ],
        \"client_ids\": [
            8
        ],
        \"revenue_tier_ids\": [
            14
        ]
    },
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": 230,
            \"cpa\": 0.2,
            \"invoice_cpc\": 250,
            \"invoice_cpa\": 0.25,
            \"user_revenue\": 1
        }
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.dev/v2/stores/15/offers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => '{accessToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'store_group_id' => 14,
            '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' => 0.3623,
            'budget_limit' => 20,
            'max_clicks' => 5,
            'valid_from' => '2025-01-10T11:10:59',
            'valid_until' => '2021-04-18',
            'todo' => [
                'owtvnaxne',
            ],
            'store_visibility' => '0',
            'show_for_advertiser' => false,
            'priority_after' => 14,
            'shared_budget_id' => 1,
            'shared_budget' => [
                'title' => 'Summer budget',
                'amount' => 10000,
            ],
            'targets' => [
                'user_ids' => [
                    7,
                ],
                'user_tag_ids' => [
                    17,
                ],
                'store_group_ids' => [
                    17,
                ],
                'emails' => [
                    '[email protected]',
                ],
                'social_media_identifiers' => [
                    'gvcwz',
                ],
                'client_ids' => [
                    8,
                ],
                'revenue_tier_ids' => [
                    14,
                ],
            ],
            'traffic_sources_costs' => [
                [
                    'source' => 1,
                    'cpc' => 230,
                    'cpa' => 0.2,
                    'invoice_cpc' => 250,
                    'invoice_cpa' => 0.25,
                    'user_revenue' => 1,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": null,
        "campaign_title": "Vincenzo McGlynn DVM",
        "campaign_text": "Magnam saepe cumque hic dolorem deleniti temporibus cum molestiae. Nobis minima corrupti sit ut. Et qui ea blanditiis enim non ipsum et non.",
        "has_product_seeding": null,
        "has_onetime_payment": null,
        "status": "active",
        "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OTc3P3RleHQ9dm9sdXB0YXM=",
        "image": null,
        "store_id": 1611,
        "token": null,
        "type": "standard",
        "warnings": {
            "skipped_targets": {
                "user_ids": [
                    12,
                    15
                ]
            }
        }
    },
    "warnings": {
        "skipped_targets": {
            "user_ids": [
                12,
                15
            ]
        }
    }
}

Display campaign

GET

https://api.metapic.dev

/v2/offers/{offer_id}

requires authentication

Returns information about a specific campaign.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

warnings

Contains any warnings when creating campaign targets

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/15556" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "campaign_title": "Kristy Rath",
    "campaign_text": "Consequuntur iste rerum nihil fuga quaerat corrupti recusandae. Quia nam architecto magnam et maxime ut. Porro dignissimos totam magni quia.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMTQ0P3RleHQ9dm9sdXB0YXM=",
    "image": null,
    "store_id": 1612,
    "token": null,
    "type": "standard"
}

Update campaign

PUT

PATCH

https://api.metapic.dev

/v2/offers/{id}

requires authentication

Updates existing campaign.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the offer.

Example:

offer_id

integer

required

The offer ID

Example:

15556

Body Parameters

store_group_id

integer

required

Store group to which the campaign belongs to. Must be one of chosen store's store groups.

Example:

type

string

required

Type of the campaign.

Must be one of:

standard
user_accept
store_accept
suggestion

Example:

standard

name

string

required

Example:

Summer campaign for VIP creators

campaign_title

string

required

The title of the campaign, visible to the creators and advertisers. Required if type != "standard". Must not be greater than 255 characters.

Example:

Summer campaign

campaign_text

string

The description of the campaign, visible to the creators and advertisers. Must not be greater than 1056 characters.

Example:

This is a summer campaign!

has_product_seeding

boolean

required

Whether the campaign offers product seeding.

Example:

has_onetime_payment

boolean

required

Whether the campaign offers a fixed fee for creators.

per_user_limit

boolean

required

Whether the click limit is applied per creator or in total.

one_time_payment

number

The fixed fee amount, if applicable.

Example:

171459.8912235

budget_limit

integer

Specifies the campaign’s budget limit in minor units (e.g., cents). Can function independently of the shared budget.

Example:

max_clicks

integer

The click limit of a campaign.

Example:

valid_from

string

The start datetime of the campaign. Must be a valid date.

Example:

2025-01-10T11:11:00

valid_until

string

The end datetime of the campaign. Must be a valid date. Must be a date after from.

Example:

1994-08-22

todo

string[]

Must not be greater than 255 characters.

Example:

["oxbrko"]

store_visibility

string

Admin-only Toggle visibility of the store for the creators:

STORE_VISIBILITY_NONE = 0 -- do nothing, keep store visibility
STORE_VISIBILITY_HIDE = 1 -- hides store, even if store set to visible
STORE_VISIBILITY_SHOW = 2 -- shows store, even if store set to hidden

Must be one of:

Example:

show_for_advertiser

boolean

Admin-only Toggle campaign visibility in the advertiser-app.

Example:

priority_after

integer

Example:

traffic_sources_costs

object[]

required

Array of traffic sources costs applicable to the campaign.

source

integer

required

Source of the cost, e.g. Other (0), Instagram (1), TikTok (2).

Example:

cpc

integer

Cost per click amount, expressed in minor unit (e.g. cents).

Example:

230

cpa

number

Cost per action, expressed in percentage / 100. Must be between 0 and 1.

Example:

0.2

invoice_cpc

integer

Admin-only cpc amount, if advertiser is invoiced directly.

Example:

250

invoice_cpa

number

Admin-only cpa amount, if advertiser is invoiced directly. Must be between 0 and 1.

Example:

0.25

user_revenue

number

Must be between 0 and 1.

Example:

targets

object[]

required

Target audience of the campaign. Each target maps to a user which will be added to the campaign.

user_ids

integer[]

Example:

[17]

user_tag_ids

integer[]

Example:

[17]

store_group_ids

integer[]

Example:

[2]

emails

string[]

The value format is invalid.

Example:

["[email protected]"]

social_media_identifiers

string[]

Must not be greater than 30 characters.

Example:

["soejylwfyqokcdqxopeqoj"]

client_ids

integer[]

Example:

[13]

revenue_tier_ids

integer[]

Example:

[1]

shared_budget_id

string

Admin-only ID of the existing shared budget to assign to the campaign. If shared_budget_id is null campaign will be unassigned from shared budget.

Example:

shared_budget

object

Admin-only Object representing the shared budget to be created and assigned to the campaign. Prohibits shared_budget_id from being present.

Response Fields

warnings

object[]

Contains any warnings for updating campaign targets

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Body

{ "store_group_id": 9, "type": "standard", "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": 171459.8912235, "budget_limit": 3, "max_clicks": 12, "valid_from": "2025-01-10T11:11:00", "valid_until": "1994-08-22", "todo": [ "oxbrko" ], "store_visibility": "0", "show_for_advertiser": true, "priority_after": 1, "traffic_sources_costs": [ { "source": 1, "cpc": 230, "cpa": 0.2, "invoice_cpc": 250, "invoice_cpa": 0.25, "user_revenue": 0 } ], "targets": [ { "user_ids": [ 17 ], "user_tag_ids": [ 17 ], "store_group_ids": [ 2 ], "emails": [ "[email protected]" ], "social_media_identifiers": [ "soejylwfyqokcdqxopeqoj" ], "client_ids": [ 13 ], "revenue_tier_ids": [ 1 ] } ], "shared_budget_id": 1, "shared_budget": { "title": "Summer budget", "amount": 10000 } }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/offers/4" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"store_group_id\": 9,
    \"type\": \"standard\",
    \"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\": 171459.8912235,
    \"budget_limit\": 3,
    \"max_clicks\": 12,
    \"valid_from\": \"2025-01-10T11:11:00\",
    \"valid_until\": \"1994-08-22\",
    \"todo\": [
        \"oxbrko\"
    ],
    \"store_visibility\": \"0\",
    \"show_for_advertiser\": true,
    \"priority_after\": 1,
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": 230,
            \"cpa\": 0.2,
            \"invoice_cpc\": 250,
            \"invoice_cpa\": 0.25,
            \"user_revenue\": 0
        }
    ],
    \"targets\": {
        \"0\": [],
        \"user_ids\": [
            17
        ],
        \"user_tag_ids\": [
            17
        ],
        \"store_group_ids\": [
            2
        ],
        \"emails\": [
            \"[email protected]\"
        ],
        \"social_media_identifiers\": [
            \"soejylwfyqokcdqxopeqoj\"
        ],
        \"client_ids\": [
            13
        ],
        \"revenue_tier_ids\": [
            1
        ]
    },
    \"shared_budget_id\": 1,
    \"shared_budget\": {
        \"title\": \"Summer budget\",
        \"amount\": 10000
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.dev/v2/offers/4';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => '{accessToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'store_group_id' => 9,
            'type' => 'standard',
            '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' => 171459.8912235,
            'budget_limit' => 3,
            'max_clicks' => 12,
            'valid_from' => '2025-01-10T11:11:00',
            'valid_until' => '1994-08-22',
            'todo' => [
                'oxbrko',
            ],
            'store_visibility' => '0',
            'show_for_advertiser' => true,
            'priority_after' => 1,
            'traffic_sources_costs' => [
                [
                    'source' => 1,
                    'cpc' => 230,
                    'cpa' => 0.2,
                    'invoice_cpc' => 250,
                    'invoice_cpa' => 0.25,
                    'user_revenue' => 0,
                ],
            ],
            'targets' => [
                [],
                'user_ids' => [
                    17,
                ],
                'user_tag_ids' => [
                    17,
                ],
                'store_group_ids' => [
                    2,
                ],
                'emails' => [
                    '[email protected]',
                ],
                'social_media_identifiers' => [
                    'soejylwfyqokcdqxopeqoj',
                ],
                'client_ids' => [
                    13,
                ],
                'revenue_tier_ids' => [
                    1,
                ],
            ],
            'shared_budget_id' => 1,
            'shared_budget' => [
                'title' => 'Summer budget',
                'amount' => 10000,
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": null,
        "campaign_title": "Breana Lang",
        "campaign_text": "Molestiae cupiditate ipsa fugit officia qui qui porro. Iure ex odio aut molestiae porro. Possimus rerum mollitia sunt impedit. Quia suscipit ut sequi minima quo.",
        "has_product_seeding": null,
        "has_onetime_payment": null,
        "status": "active",
        "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjU1P3RleHQ9cmVwdWRpYW5kYWU=",
        "image": null,
        "store_id": 1613,
        "token": null,
        "type": "standard",
        "warnings": {
            "skipped_targets": {
                "user_ids": [
                    12,
                    15
                ]
            }
        }
    },
    "warnings": {
        "skipped_targets": {
            "user_ids": [
                12,
                15
            ]
        }
    }
}

Delete campaign

DELETE

https://api.metapic.dev

/v2/offers/{id}

requires authentication

Soft deletes a campaign.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the offer.

Example:

offer_id

integer

required

The offer ID

Example:

15556

Auth

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.metapic.dev/v2/offers/7" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

List campaigns

GET

https://api.metapic.dev

/v2/offers

requires authentication

Endpoint for querying & sorting all campaigns.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

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.

Example:

black friday

statuses

string[]

Must be one of:

deleted
ended
scheduled
paused
active

Example:

["ended"]

store_ids

integer[]

Query by offer's store. Returns all offers which belong to the given store_ids.

Example:

[1]

store_group_ids

integer[]

Query by offer's store group. Returns all offers which belong to the given store_group_ids.

Example:

[1]

created_by

integer

required

Query by offer's author ID. Returns all offers created by the user making the request

Example:

or_id

integer

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.

Example:

1234

target_user_id

integer

Example:

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

sort_by

string

Example:

created_at:desc

custom_sort_by

string

Must be one of:

ends_soon

Example:

ends_soon

include

string[]

Include optional relationships in the response.

Must be one of:

trafficSourcesCosts
store
targets
sharedBudget

Example:

["trafficSourcesCosts"]

format

string

Must be one of:

csv
xlsx

Example:

csv

Response Fields

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers?query=black+friday&statuses[]=ended&store_ids[]=1&store_group_ids[]=1&created_by=10&or_id=1234&target_user_id=15&size=20&sort_by=created_at%3Adesc&custom_sort_by=ends_soon&include[]=trafficSourcesCosts&format=csv" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "campaign_title": "Dr. Mariela Dooley II",
            "campaign_text": "Rerum repellat voluptate placeat adipisci rem pariatur. Eaque optio sed minus repellendus. Quo numquam rem delectus unde. Autem est quidem consequatur beatae ea dolorem.",
            "has_product_seeding": null,
            "has_onetime_payment": null,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NTY2P3RleHQ9b21uaXM=",
            "image": null,
            "store_id": 1614,
            "token": null,
            "type": "standard"
        },
        {
            "id": null,
            "campaign_title": "Dr. Jessy Conroy III",
            "campaign_text": "Sed placeat quibusdam et excepturi. Autem doloremque modi sunt molestiae nesciunt. Ad perspiciatis incidunt quo quia a est quidem.",
            "has_product_seeding": null,
            "has_onetime_payment": null,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWJiP3RleHQ9Y3VtcXVl",
            "image": null,
            "store_id": 1615,
            "token": null,
            "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": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Upload campaign image

POST

https://api.metapic.dev

/v2/offers/{offer_id}/uploads

requires authentication

Uploads an image to a campaign.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Body Parameters

default

string

required

Max size: 10240 kb. Allowed types: image/*.

Example:

Response Fields

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Body

{ "default": "et" }

Received response

Example request:

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\": \"et\"
}"

Example response:

{
    "id": null,
    "campaign_title": "Claud Hammes",
    "campaign_text": "Ipsa et quod est nostrum voluptatum iste ut. Minus delectus aut mollitia quo quidem. Porro tenetur dolore dolores doloribus aliquam.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2Njk5P3RleHQ9YXV0",
    "image": null,
    "store_id": 1616,
    "token": null,
    "type": "standard"
}

Pause campaign

PUT

https://api.metapic.dev

/v2/offers/{offer_id}/pause

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/offers/15556/pause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "campaign_title": "Prof. Melyna Schmeler V",
    "campaign_text": "Laudantium quaerat consectetur voluptatum qui provident. Quasi cupiditate et temporibus possimus sit et. Rem alias occaecati quam molestias ducimus nulla quas.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMjIyP3RleHQ9bmVtbw==",
    "image": null,
    "store_id": 1617,
    "token": null,
    "type": "standard"
}

Unpause campaign

PUT

https://api.metapic.dev

/v2/offers/{offer_id}/unpause

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/offers/15556/unpause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "campaign_title": "Hudson Nicolas",
    "campaign_text": "Quis ipsam et ut sit. Exercitationem aliquam debitis dolorem laborum optio quibusdam. Tempore earum sit iure sapiente sunt minus.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTg4P3RleHQ9bmloaWw=",
    "image": null,
    "store_id": 1618,
    "token": null,
    "type": "standard"
}

Pause campaign

POST

https://api.metapic.dev

/v2/offers/{offer_id}/pause

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/offers/15556/pause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "campaign_title": "Boyd Bergnaum DDS",
    "campaign_text": "Rerum eius sequi ut esse. Id laboriosam quia quo incidunt. Quo ullam sunt quas sed. Aut nostrum itaque voluptatem ut.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZWVlP3RleHQ9cmVwcmVoZW5kZXJpdA==",
    "image": null,
    "store_id": 1619,
    "token": null,
    "type": "standard"
}

Unpause campaign

POST

https://api.metapic.dev

/v2/offers/{offer_id}/unpause

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/offers/15556/unpause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "campaign_title": "Nigel Rau",
    "campaign_text": "Et nisi adipisci mollitia vero. Sed vero voluptas reiciendis et vitae ea. Aut dolorem unde et. Incidunt rem tempora autem reiciendis.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBlZTIyP3RleHQ9ZXhwZWRpdGE=",
    "image": null,
    "store_id": 1620,
    "token": null,
    "type": "standard"
}

Display campaign stats

GET

https://api.metapic.dev

/v2/offers/{offer_id}/stats

requires authentication

Returns statistics about a specific campaign.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Query Parameters

start_date

string

required

The start date for the stats period (YYYY-MM-DD)

Example:

2023-01-01

end_date

string

required

The end date for the stats period (YYYY-MM-DD)

Example:

2023-01-31

Body Parameters

start_date

string

required

Must be a valid date. Must be a date before or equal to end_date.

Example:

2017-12-10

end_date

string

required

Must be a valid date. Must be a date after or equal to start_date.

Example:

2093-09-19

Auth

Headers

URL Parameters

Query Parameters

Body

{ "start_date": "2017-12-10", "end_date": "2093-09-19" }

Received response

Example request:

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\": \"2017-12-10\",
    \"end_date\": \"2093-09-19\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

GET v2/users/{user_id}/offers

GET

https://api.metapic.dev

/v2/users/{user_id}/offers

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

status

string

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

applied

name

string

Must not be greater than 128 characters.

Example:

scsbhncq

Auth

Headers

URL Parameters

Body

{ "status": "applied", "name": "scsbhncq" }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/users/1/offers" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"applied\",
    \"name\": \"scsbhncq\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Display campaign

GET

https://api.metapic.dev

/v2/offer-by-token/{offer_token}

requires authentication

Returns information about a specific campaign.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_token

string

required

Example:

totam

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

warnings

Contains any warnings when creating campaign targets

status

enum

The status of the campaign. Can be one of: ended, scheduled, paused, active, deleted

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offer-by-token/totam" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "campaign_title": "Olin Reinger",
    "campaign_text": "Quos nemo minima vero facere. Dolores laudantium quia quia qui. Reiciendis qui quos nulla cupiditate dolore.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAyMmVlP3RleHQ9ZW9z",
    "image": null,
    "store_id": 1644,
    "token": null,
    "type": "standard"
}

Offer Target

Get targets for offer

GET

https://api.metapic.dev

/v2/offers/{offer_id}/targets

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

user_ids

string[]

store_group_ids

string[]

user_tag_ids

string[]

client_ids

string[]

revenue_tier_ids

string[]

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/15556/targets" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Add new targets to offer

POST

https://api.metapic.dev

/v2/offers/{offer_id}/targets

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The offer ID

Example:

15556

Body Parameters

user_ids

integer[]

Example:

[19]

user_tag_ids

integer[]

Example:

[1]

store_group_ids

integer[]

Example:

[2]

emails

string[]

The value format is invalid.

Example:

["[email protected]"]

social_media_identifiers

string[]

Must not be greater than 30 characters.

Example:

["khrdlptzcyw"]

client_ids

integer[]

Example:

[2]

revenue_tier_ids

integer[]

Example:

[1]

Response Fields

user_ids

string[]

store_group_ids

string[]

user_tag_ids

string[]

client_ids

string[]

revenue_tier_ids

string[]

warnings

Contains any warnings when adding targets

Auth

Headers

URL Parameters

Body

{ "user_ids": [ 19 ], "user_tag_ids": [ 1 ], "store_group_ids": [ 2 ], "emails": [ "[email protected]" ], "social_media_identifiers": [ "khrdlptzcyw" ], "client_ids": [ 2 ], "revenue_tier_ids": [ 1 ] }

Received response

Example request:

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\": [
        1
    ],
    \"store_group_ids\": [
        2
    ],
    \"emails\": [
        \"[email protected]\"
    ],
    \"social_media_identifiers\": [
        \"khrdlptzcyw\"
    ],
    \"client_ids\": [
        2
    ],
    \"revenue_tier_ids\": [
        1
    ]
}"

Offer Participant

Checks if user has been added to the offer.

GET

https://api.metapic.dev

/v2/offers/{offer_id}/users/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The ID of the offer.

Example:

integer

required

The ID of the user.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/12/users/2" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

List participants in a campaign

GET

https://api.metapic.dev

/v2/offers/{offer_id}/participants

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The ID of the offer.

Example:

Body Parameters

query

string

Must not be greater than 128 characters.

Example:

ydlpnqgfz

status

string

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

done

participants_v2

boolean

Example:

Response Fields

offer_comments_count

The number of comments on this participation.

integer

The unique id of this participant

offer_id

integer

The id of the offer for this participant

display_name

string

The name of the participant

clicks

integer

The number of clicks left for this participant

status

string

The status of this campaign participant

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

pre_registered_email

string|null

The email by which/if the participant was added to the campaign

pre_registered_identifier

string|null

The social media identifier by which/if the participant was added to the campaign

todo

array|null

List of todo items

user_id

int|null

The id of the user, if Metapic user is linked to the participant

username

string|null

The username of the user, if Metapic user is linked to the participant

avatar

string|null

The image associated with the user through social media identifier

social_media

array|null

List of user's social media, if available

Get participant details

GET

https://api.metapic.dev

/v2/offers/{offer_id}/participants/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The ID of the offer.

Example:

integer

required

The ID of the participant.

Example:

Response Fields

integer

The unique id of this participant

offer_id

integer

The id of the offer for this participant

display_name

string

The name of the participant

clicks

integer

The number of clicks left for this participant

status

string

The status of this campaign participant

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

pre_registered_email

string|null

The email by which/if the participant was added to the campaign

pre_registered_identifier

string|null

The social media identifier by which/if the participant was added to the campaign

todo

array|null

List of todo items

user_id

int|null

The id of the user, if Metapic user is linked to the participant

username

string|null

The username of the user, if Metapic user is linked to the participant

avatar

string|null

The image associated with the user through social media identifier

social_media

array|null

List of user's social media, if available

Retrieve participants statistics for an offer

GET

https://api.metapic.dev

/v2/offers/{offer_id}/participants-stats

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The ID of the offer.

Example:

Body Parameters

query

string

Must not be greater than 64 characters.

Example:

active

boolean

required

start_date

string

required

Must be a valid date. Must be a date before or equal to end_date.

Example:

2009-11-13

end_date

string

required

Must be a valid date. Must be a date after or equal to start_date.

Example:

2029-04-30

sort_by

string

Must match the regex /^(clicks|links_created|estimated_gp|estimated_earning_to_cost_ratio):(asc|desc)$/.

Example:

estimated_gp:desc

Response Fields

integer

The unique id of this participant

user_id

int|null

The id of the user, if Metapic user is linked to the participant

display_name

string

The name of the participant

username

string|null

The username of the user, if Metapic user is linked to the participant

avatar

string|null

The image associated with the user through social media identifier

status

string

The status of this campaign participant

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

links_created

integer

The number of links created for this participant

clicks

integer

The number of clicks left for this participant

estimated_gp

number

The estimated GP for this participant

estimated_earning_to_cost_ratio

number

The estimated earning to cost ratio for this participant

Auth

Headers

URL Parameters

Body

{ "query": "g", "active": false, "start_date": "2009-11-13", "end_date": "2029-04-30", "sort_by": "estimated_gp:desc" }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/19/participants-stats" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"g\",
    \"active\": false,
    \"start_date\": \"2009-11-13\",
    \"end_date\": \"2029-04-30\",
    \"sort_by\": \"estimated_gp:desc\"
}"

Example response:

{
    "data": [
        {
            "id": null,
            "user_id": null,
            "display_name": "[email protected]",
            "clicks": 799770851,
            "status": "denied",
            "username": null,
            "links_created": null,
            "estimated_gp": null,
            "estimated_earning_to_cost_ratio": null
        },
        {
            "id": null,
            "user_id": 2673,
            "display_name": "brooklyn.kub",
            "clicks": 29420826,
            "status": "open",
            "username": "brooklyn.kub",
            "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": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Retrieve participants count by active/inactive

GET

https://api.metapic.dev

/v2/offers/{offer_id}/participants-count-by-click-activity

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The ID of the offer.

Example:

Body Parameters

start_date

string

required

Must be a valid date. Must be a date before or equal to end_date.

Example:

2017-11-01

end_date

string

required

Must be a valid date. Must be a date after or equal to start_date.

Example:

2081-07-05

Auth

Headers

URL Parameters

Body

{ "start_date": "2017-11-01", "end_date": "2081-07-05" }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/20/participants-count-by-click-activity" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2017-11-01\",
    \"end_date\": \"2081-07-05\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update participant status

PATCH

https://api.metapic.dev

/v2/offers/{offer_id}/participants/{participant_id}/update-status

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_id

integer

required

The ID of the offer.

Example:

participant_id

integer

required

The ID of the participant.

Example:

Body Parameters

status

string

required

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

denied

Response Fields

integer

The unique id of this participant

offer_id

integer

The id of the offer for this participant

display_name

string

The name of the participant

clicks

integer

The number of clicks left for this participant

status

string

The status of this campaign participant

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

pre_registered_email

string|null

The email by which/if the participant was added to the campaign

pre_registered_identifier

string|null

The social media identifier by which/if the participant was added to the campaign

todo

array|null

List of todo items

user_id

int|null

The id of the user, if Metapic user is linked to the participant

username

string|null

The username of the user, if Metapic user is linked to the participant

avatar

string|null

The image associated with the user through social media identifier

social_media

array|null

List of user's social media, if available

Checks if user has been added to the offer.

GET

https://api.metapic.dev

/v2/offer-by-token/{offer_token}/users/{userId}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_token

string

required

Example:

earum

userId

integer

required

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offer-by-token/earum/users/7" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                                                                                    set-cookie
                                                            : metapic_session=eyJpdiI6InRxRVJURTNOa1EzNUMzR3NMTXNpMVE9PSIsInZhbHVlIjoieDk4RjRZN2JNaDRCNTlhUkVJOGd6azBmV29tcDF2anQvZXFZc1g3SlI4MDBWZlRCNXhwbUNTckdKbjU5ZEo1YkxDbzFZRkl2NlRaOCsrMVZDeCs0bGtlT0YyTlZoczAzSmdNZmV3Q2N4RDdrd1hOMDhHVThoc29tZVp3cEI1Qi8iLCJtYWMiOiIxMDYwODFlZmIyYTU2ZTgzOGE5MDI1NmJiNGQ0MWUzNzdiZjRmYzZhNTM2ODE1ZWY5ZWJkZTA0YjljNTJhNWE3IiwidGFnIjoiIn0%3D; expires=Fri, 10 Jan 2025 12:11:00 GMT; Max-Age=7200; path=/; httponly

{
    "message": "Unauthenticated."
}

Mark user as having joined the campaign

POST

https://api.metapic.dev

/v2/offer-by-token/{offer_token}/users/{user_id}/join

requires authentication

This can only be performed by the user themselves.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_token

string

required

Example:

user_id

integer

required

The ID of the user.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/offer-by-token/et/users/10/join" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Comment

Add OfferUser comment

POST

https://api.metapic.dev

/v2/offer-users/{offer_user_id}/comments

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_user_id

string

required

The ID of the offerUser.

Example:

Body Parameters

comment

string

required

Must not be greater than 15000 characters.

Example:

cykecfxqevrdfmqxuhyvdm

Auth

Headers

URL Parameters

Body

{ "comment": "cykecfxqevrdfmqxuhyvdm" }

Received response

Example request:

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\": \"cykecfxqevrdfmqxuhyvdm\"
}"

Update OfferUser comment

PUT

PATCH

https://api.metapic.dev

/v2/offer-users/{offer_user_id}/comments/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_user_id

string

required

The ID of the offerUser.

Example:

integer

required

The ID of the comment.

Example:

offer_comment_id

string

required

The ID of the comment.

Example:

Body Parameters

comment

string

required

Must not be greater than 15000 characters.

Example:

toyxrgn

Auth

Headers

URL Parameters

Body

{ "comment": "toyxrgn" }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/offer-users/1/comments/5" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"comment\": \"toyxrgn\"
}"

Delete OfferUser comment

DELETE

https://api.metapic.dev

/v2/offer-users/{offer_user_id}/comments/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_user_id

string

required

The ID of the offerUser.

Example:

integer

required

The ID of the comment.

Example:

offerCommentId

string

required

The ID of the comment.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.metapic.dev/v2/offer-users/1/comments/6" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Activity

Get the list of activities on OfferUser card

GET

https://api.metapic.dev

/v2/offer-users/{offerUser}/activities

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offerUser

integer

required

Example:

Response Fields

type

The type of the activity. Can be one of the following values:
- COMMENT
- DELETED_COMMENT
- STATUS_CHANGE

actor_id

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

Unique identifier of the comment.
Present when type is COMMENT

comment_text

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

Indicates time at which the activity happened.

updated_at

string

Time of last editing.
Present if comment was edited

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offer-users/5/activities" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Return Ads

List Return Ads

GET

https://api.metapic.dev

/v2/return-ads

requires authentication

Paginated list of Return Ads

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

query

string

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.

Example:

internal name

advertiser_group_ids

integer[]

Query by return ad's advertiser group. Returns all return ads which belong to the given advertiser_group_ids.

Example:

[1]

advertiser_ids

integer[]

Query by return ad's advertiser. Returns all return ads which belong to the given advertiser_ids.

Example:

[1]

statuses

string[]

Must be one of:

deleted
ended
scheduled
paused
active

Example:

["deleted"]

created_by

integer

Must be one of:

or_id

integer

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.

Example:

1234

sort_by

string

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.

Must be one of:

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

Example:

current_clicks:asc

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

Query Parameters

Received response

Example request:

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"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Orlo Johns",
            "advertiser_group_id": 3368,
            "affiliate_link": {
                "id": 759,
                "url": "http://schinner.info/",
                "original_url": "http://dach.org/maxime-possimus-similique-tenetur-a-qui",
                "mtpc_url": "https://c.mtpc.se/759",
                "user_id": 2676,
                "country": "GR",
                "provider": "fuchsia",
                "advertiser": {
                    "id": 1632,
                    "name": "Eichmann PLC"
                }
            },
            "author_id": 2677,
            "display_for_all_advertisers": false,
            "status": "active",
            "styles": null,
            "image": null,
            "starts_at": "2024-12-10T10:11:00.446288Z",
            "ends_at": "2025-02-10T10:11:00.446331Z",
            "stats": []
        },
        {
            "id": null,
            "name": "Jerel Krajcik",
            "advertiser_group_id": 3371,
            "affiliate_link": {
                "id": 760,
                "url": "http://www.dare.biz/",
                "original_url": "http://littel.com/commodi-unde-voluptatem-sed-fuga-ut-modi-enim-animi",
                "mtpc_url": "https://c.mtpc.se/760",
                "user_id": 2678,
                "country": "BA",
                "provider": "navy",
                "advertiser": {
                    "id": 1633,
                    "name": "Purdy-Huels"
                }
            },
            "author_id": 2679,
            "display_for_all_advertisers": false,
            "status": "active",
            "styles": null,
            "image": null,
            "starts_at": "2024-12-10T10:11:00.460970Z",
            "ends_at": "2025-02-10T10:11:00.461009Z",
            "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": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Create Return Ad

POST

https://api.metapic.dev

/v2/return-ads

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The internal name of the Return Ad. Must not be greater than 255 characters.

Example:

blnlxtxlvgoulmkoion

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs.

Example:

return_link

string

required

The URL to redirect users upon clicking the Return Ad. The link must belong to advertisers within the specified advertiser group. Must be a valid URL. Must not be greater than 2048 characters.

Example:

https://advertiser.com

display_for_all_advertisers

boolean

required

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group. When set to true, all associated advertisers and categories will be removed.

advertiser_ids

integer[]

Specific advertiser IDs to display the Return Ad to. This field is excluded if display_for_all_advertisers is set to true. When set to null, all associated advertisers will be removed.

Example:

[7]

advertiser_category_ids

integer[]

Specific advertiser category IDs to display the Return Ad to. This field is excluded if display_for_all_advertisers is set to true. When set to null, all associated advertiser categories will be removed.

Example:

[4]

styles

object

required

An object of style attributes for the Return Ad.

Example:

{"color":"#ffffff"}

image_key

string

The image key, provided as a base64-encoded image path. Exclude from the request to keep current image.

Example:

dG1wL2ltYWdlLmpwZw==

starts_at

string

The start datetime for when the Return Ad becomes active. Must be a valid date.

Example:

2025-01-10T11:11:00

ends_at

string

The end datetime for when the Return Ad is deactivated. Must be a valid date. Must be a date after starts_at.

Example:

2060-03-01

click_limit

integer

Specifies the Return Ad's click limit.

Example:

view_limit

integer

Specifies the Return Ad's view limit.

Example:

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

Body

{ "name": "blnlxtxlvgoulmkoion", "advertiser_group_id": 5, "return_link": "https:\/\/advertiser.com", "display_for_all_advertisers": false, "advertiser_ids": [ 7 ], "advertiser_category_ids": [ 4 ], "styles": { "color": "#ffffff" }, "image_key": "dG1wL2ltYWdlLmpwZw==", "starts_at": "2025-01-10T11:11:00", "ends_at": "2060-03-01", "click_limit": 19, "view_limit": 4 }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/return-ads" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"blnlxtxlvgoulmkoion\",
    \"advertiser_group_id\": 5,
    \"return_link\": \"https:\\/\\/advertiser.com\",
    \"display_for_all_advertisers\": false,
    \"advertiser_ids\": [
        7
    ],
    \"advertiser_category_ids\": [
        4
    ],
    \"styles\": {
        \"color\": \"#ffffff\"
    },
    \"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
    \"starts_at\": \"2025-01-10T11:11:00\",
    \"ends_at\": \"2060-03-01\",
    \"click_limit\": 19,
    \"view_limit\": 4
}"

Example response:

{
    "id": null,
    "name": "Stanley Zboncak",
    "advertiser_group_id": 3374,
    "affiliate_link": {
        "id": 761,
        "url": "http://okon.com/sit-sint-et-doloremque-eveniet-expedita-quis.html",
        "original_url": "http://www.cronin.com/est-aliquam-rerum-quos-itaque-nemo",
        "mtpc_url": "https://c.mtpc.se/761",
        "user_id": 2680,
        "country": "GP",
        "provider": "green",
        "advertiser": {
            "id": 1634,
            "name": "Glover Inc"
        }
    },
    "author_id": 2681,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-10T10:11:00.501130Z",
    "ends_at": "2025-02-10T10:11:00.501170Z",
    "stats": []
}

Get Return Ad

GET

https://api.metapic.dev

/v2/return-ads/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the return ad.

Example:

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/return-ads/10" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "name": "Wilhelm Murazik",
    "advertiser_group_id": 3377,
    "affiliate_link": {
        "id": 762,
        "url": "https://powlowski.com/libero-esse-placeat-et-dolorem-minima-iusto-fugit.html",
        "original_url": "http://www.fahey.com/id-molestiae-at-aut-et-cupiditate-in-qui",
        "mtpc_url": "https://c.mtpc.se/762",
        "user_id": 2682,
        "country": "TT",
        "provider": "olive",
        "advertiser": {
            "id": 1635,
            "name": "D'Amore-Kub"
        }
    },
    "author_id": 2683,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-10T10:11:00.533005Z",
    "ends_at": "2025-02-10T10:11:00.533047Z",
    "stats": []
}

Update Return Ad

PUT

PATCH

https://api.metapic.dev

/v2/return-ads/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the return ad.

Example:

Body Parameters

name

string

required

The internal name of the Return Ad. Must not be greater than 255 characters.

Example:

omyznhkfutvmpxygyilozjhf

advertiser_group_id

string

The advertiser group to which the Return Ad belongs.

return_link

string

The URL to redirect users upon clicking the Return Ad. The link must belong to advertisers within the specified advertiser group.

Example:

https://advertiser.com

display_for_all_advertisers

boolean

required

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group. When set to true, all associated advertisers and categories will be removed.

advertiser_ids

integer[]

Specific advertiser IDs to display the Return Ad to. This field is excluded if display_for_all_advertisers is set to true. When set to null, all associated advertisers will be removed.

Example:

[18]

advertiser_category_ids

integer[]

Example:

[13]

styles

object

required

An object of style attributes for the Return Ad.

Example:

{"color":"#ffffff"}

image_key

string

The image key, provided as a base64-encoded image path. Exclude from the request to keep current image.

Example:

dG1wL2ltYWdlLmpwZw==

starts_at

string

The start datetime for when the Return Ad becomes active. Must be a valid date.

Example:

2025-01-10T11:11:00

ends_at

string

The end datetime for when the Return Ad is deactivated. Must be a valid date. Must be a date after starts_at.

Example:

2071-12-08

click_limit

integer

Specifies the Return Ad's click limit.

Example:

view_limit

integer

Specifies the Return Ad's view limit.

Example:

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

URL Parameters

Body

{ "name": "omyznhkfutvmpxygyilozjhf", "advertiser_group_id": null, "return_link": "https:\/\/advertiser.com", "display_for_all_advertisers": false, "advertiser_ids": [ 18 ], "advertiser_category_ids": [ 13 ], "styles": { "color": "#ffffff" }, "image_key": "dG1wL2ltYWdlLmpwZw==", "starts_at": "2025-01-10T11:11:00", "ends_at": "2071-12-08", "click_limit": 9, "view_limit": 12 }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/return-ads/17" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"omyznhkfutvmpxygyilozjhf\",
    \"return_link\": \"https:\\/\\/advertiser.com\",
    \"display_for_all_advertisers\": false,
    \"advertiser_ids\": [
        18
    ],
    \"advertiser_category_ids\": [
        13
    ],
    \"styles\": {
        \"color\": \"#ffffff\"
    },
    \"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
    \"starts_at\": \"2025-01-10T11:11:00\",
    \"ends_at\": \"2071-12-08\",
    \"click_limit\": 9,
    \"view_limit\": 12
}"

Example response:

{
    "id": null,
    "name": "Tommie Reilly",
    "advertiser_group_id": 3380,
    "affiliate_link": {
        "id": 763,
        "url": "http://www.torphy.com/voluptatem-eius-omnis-eligendi-est-harum-quae-laborum.html",
        "original_url": "https://www.kertzmann.info/ut-quis-quia-dignissimos-culpa-ut-ipsum-aut-minus",
        "mtpc_url": "https://c.mtpc.se/763",
        "user_id": 2684,
        "country": "CV",
        "provider": "fuchsia",
        "advertiser": {
            "id": 1636,
            "name": "Goldner LLC"
        }
    },
    "author_id": 2685,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-10T10:11:00.565544Z",
    "ends_at": "2025-02-10T10:11:00.565583Z",
    "stats": []
}

Delete Return Ad

DELETE

https://api.metapic.dev

/v2/return-ads/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the return ad.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.metapic.dev/v2/return-ads/19" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Pause Return Ad

POST

https://api.metapic.dev

/v2/return-ads/{returnAd_id}/pause

requires authentication

Deactivates Return Ad

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

returnAd_id

integer

required

The ID of the returnAd.

Example:

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/return-ads/9/pause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "name": "Lolita Mayer",
    "advertiser_group_id": 3383,
    "affiliate_link": {
        "id": 764,
        "url": "https://www.goldner.org/qui-nam-veritatis-quis-sed-quibusdam-aspernatur-fuga-perferendis",
        "original_url": "http://jones.com/rem-commodi-qui-blanditiis-incidunt-exercitationem.html",
        "mtpc_url": "https://c.mtpc.se/764",
        "user_id": 2686,
        "country": "PM",
        "provider": "olive",
        "advertiser": {
            "id": 1637,
            "name": "Wyman PLC"
        }
    },
    "author_id": 2687,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-10T10:11:00.599235Z",
    "ends_at": "2025-02-10T10:11:00.599301Z",
    "stats": []
}

Unpause Return Ad

POST

https://api.metapic.dev

/v2/return-ads/{returnAd_id}/unpause

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

returnAd_id

integer

required

The ID of the returnAd.

Example:

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/return-ads/12/unpause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "name": "Miss Blanche Veum Jr.",
    "advertiser_group_id": 3386,
    "affiliate_link": {
        "id": 765,
        "url": "http://www.kautzer.org/odit-non-atque-qui-qui-dolorem-dolorem.html",
        "original_url": "http://www.lowe.com/delectus-ex-nisi-quidem-nihil-ipsa-facilis-possimus.html",
        "mtpc_url": "https://c.mtpc.se/765",
        "user_id": 2688,
        "country": "BE",
        "provider": "blue",
        "advertiser": {
            "id": 1638,
            "name": "Kirlin and Sons"
        }
    },
    "author_id": 2689,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-10T10:11:00.629339Z",
    "ends_at": "2025-02-10T10:11:00.629405Z",
    "stats": []
}

Preview return ad affiliate link

POST

https://api.metapic.dev

/v2/affiliate-link-preview

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

link

string

required

Must be a valid URL. Must not be greater than 2048 characters.

Example:

ycebhomeakifs

advertiser_group_id

integer

required

Example:

Response Fields

status

The result of the affiliate link conversion

advertiser

object

The advertiser associated with the affiliate link

Auth

Headers

Body

{ "link": "ycebhomeakifs", "advertiser_group_id": 14 }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/affiliate-link-preview" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"link\": \"ycebhomeakifs\",
    \"advertiser_group_id\": 14
}"

Get Return Ads for Advertiser

GET

https://api.metapic.dev

/v2/advertisers/{store_id}/return-ads

requires authentication

List of Return Ads displayed for Advertiser by ID

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The ID of the store.

Example:

Response Fields

name

string

Internal name

advertiser_group_id

integer

The advertiser group to which the Return Ad belongs

affiliate_link

object

The affiliate link for the Return Ad.

author_id

integer

The id of Return Ad author

display_for_all_advertisers

boolean

Indicates whether the Return Ad should be displayed to all advertisers in the selected advertiser group

advertisers

string[]

List of advertisers the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser.

advertiser_categories

string[]

List of advertiser categories the Return Ad is targeted to.

id - int Unique identifier of the advertiser.
name - string The name of the advertiser category.

styles

object

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

The status of the return ad.

starts_at

date

The start datetime for when the Return Ad becomes active.

ends_at

date

The end datetime for when the Return Ad is deactivated.

click_limit

integer

The click limit of the Return Ad.

view_limit

integer

The view limit of the Return Ad.

stats

object

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, order_count, order_value and earnings)

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/6/return-ads" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[
    {
        "id": null,
        "name": "Nola Rogahn",
        "advertiser_group_id": 3389,
        "affiliate_link": {
            "id": 766,
            "url": "http://bogan.info/sunt-nemo-sed-maxime-enim-molestias-et-veritatis",
            "original_url": "http://www.bergstrom.com/saepe-soluta-dolor-commodi-dolore",
            "mtpc_url": "https://c.mtpc.se/766",
            "user_id": 2690,
            "country": "MC",
            "provider": "olive",
            "advertiser": {
                "id": 1639,
                "name": "Herzog Inc"
            }
        },
        "author_id": 2691,
        "display_for_all_advertisers": false,
        "status": "active",
        "styles": null,
        "image": null,
        "starts_at": "2024-12-10T10:11:00.661630Z",
        "ends_at": "2025-02-10T10:11:00.661672Z",
        "stats": []
    },
    {
        "id": null,
        "name": "Dr. Amie Brekke Jr.",
        "advertiser_group_id": 3392,
        "affiliate_link": {
            "id": 767,
            "url": "http://www.metz.info/veniam-repudiandae-repellat-odit-pariatur-incidunt-voluptatem",
            "original_url": "https://bernier.biz/deserunt-iusto-eveniet-inventore-laboriosam.html",
            "mtpc_url": "https://c.mtpc.se/767",
            "user_id": 2692,
            "country": "AD",
            "provider": "aqua",
            "advertiser": {
                "id": 1640,
                "name": "Zboncak LLC"
            }
        },
        "author_id": 2693,
        "display_for_all_advertisers": false,
        "status": "active",
        "styles": null,
        "image": null,
        "starts_at": "2024-12-10T10:11:00.676055Z",
        "ends_at": "2025-02-10T10:11:00.676132Z",
        "stats": []
    }
]

Shared Budget

List Shared Budgets

GET

https://api.metapic.dev

/v2/stores/{store_id}/shared-budgets

requires authentication

List Shared Budgets for Store

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The ID of the store.

Example:

Response Fields

title

string

Shared budget title

amount

integer

Amount of the shared budget, in minor units (e.g., cents).

consumed_budget

integer

The amount of budget that has been consumed or spent from the shared budget, expressed in minor units (e.g., cents).

currency

string

Shared budget currency is the same as advertiser

campaigns_count

integer

Number of campaigns assigned to the budget.

campaigns

App\Http\Resources\SharedBudget\CampaignBudgetProgressResource

List of campaigns associated with this shared budget.

Only present on display budget

id - int Unique identifier of the campaign.
title - string The title of the campaign.
name - string The internal name of the campaign.
consumed_budget - int The current amount of money used by the campaign, expressed in minor units (e.g., cents).
status - string Current status of the campaign (e.g., active, ended).
budget_limit - int Budget limit for the campaign, if applicable.
budget_limit_reached_at - string Timestamp when the budget limit was reached.

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/stores/14/shared-budgets" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[
    {
        "id": null,
        "title": "Grady Glover",
        "amount": 5,
        "consumed_budget": 0,
        "currency": "GBP"
    },
    {
        "id": null,
        "title": "Fiona Towne",
        "amount": 9,
        "consumed_budget": 0,
        "currency": "GBP"
    }
]

Display Budget

GET

https://api.metapic.dev

/v2/stores/{store_id}/shared-budgets/{id}

requires authentication

Returns information about a specific budget.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The ID of the store.

Example:

integer

required

The ID of the shared budget.

Example:

Response Fields

title

string

Shared budget title

amount

integer

Amount of the shared budget, in minor units (e.g., cents).

consumed_budget

integer

The amount of budget that has been consumed or spent from the shared budget, expressed in minor units (e.g., cents).

currency

string

Shared budget currency is the same as advertiser

campaigns_count

integer

Number of campaigns assigned to the budget.

campaigns

App\Http\Resources\SharedBudget\CampaignBudgetProgressResource

List of campaigns associated with this shared budget.

Only present on display budget

id - int Unique identifier of the campaign.
title - string The title of the campaign.
name - string The internal name of the campaign.
consumed_budget - int The current amount of money used by the campaign, expressed in minor units (e.g., cents).
status - string Current status of the campaign (e.g., active, ended).
budget_limit - int Budget limit for the campaign, if applicable.
budget_limit_reached_at - string Timestamp when the budget limit was reached.

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/stores/11/shared-budgets/18" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "title": "Mr. Vinnie Pacocha DVM",
    "amount": 5,
    "consumed_budget": 0,
    "currency": "SEK"
}

Update Shared Budget

PUT

PATCH

https://api.metapic.dev

/v2/stores/{store_id}/shared-budgets/{id}

requires authentication

Updates existing budget.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The ID of the store.

Example:

integer

required

The ID of the shared budget.

Example:

Body Parameters

title

string

Title of the shared budget. Must be at least 3 characters. Must not be greater than 255 characters.

Example:

Summer budget

amount

integer

Amount of the shared budget, in minor units (e.g., cents). When lowering the amount all the campaigns added to this shared budget may be marked as ended as a side-effect. When increasing the amount all campaigns which have ended due to budget_limit_reached_at may be reopened.

Example:

10000

Response Fields

title

string

Shared budget title

amount

integer

Amount of the shared budget, in minor units (e.g., cents).

consumed_budget

integer

The amount of budget that has been consumed or spent from the shared budget, expressed in minor units (e.g., cents).

currency

string

Shared budget currency is the same as advertiser

campaigns_count

integer

Number of campaigns assigned to the budget.

campaigns

App\Http\Resources\SharedBudget\CampaignBudgetProgressResource

List of campaigns associated with this shared budget.

Only present on display budget

id - int Unique identifier of the campaign.
title - string The title of the campaign.
name - string The internal name of the campaign.
consumed_budget - int The current amount of money used by the campaign, expressed in minor units (e.g., cents).
status - string Current status of the campaign (e.g., active, ended).
budget_limit - int Budget limit for the campaign, if applicable.
budget_limit_reached_at - string Timestamp when the budget limit was reached.

Auth

Headers

URL Parameters

Body

{ "title": "Summer budget", "amount": 10000 }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/stores/11/shared-budgets/10" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Summer budget\",
    \"amount\": 10000
}"

Example response:

{
    "id": null,
    "title": "Mr. Terrance Legros DVM",
    "amount": 1,
    "consumed_budget": 0,
    "currency": "PLN"
}

Delete Shared Budget

DELETE

https://api.metapic.dev

/v2/stores/{store_id}/shared-budgets/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The ID of the store.

Example:

integer

required

The ID of the shared budget.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.metapic.dev/v2/stores/7/shared-budgets/1" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Store

List stores

GET

https://api.metapic.dev

/v2/stores

requires authentication

Endpoint for querying & sorting all stores.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

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.

Example:

nike

store_group_id

integer

Query by store's store group. Returns all stores which belong to the given store_group_id.

Example:

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

sort_by

string

Example:

created_at:desc

Auth

Headers

Query Parameters

Received response

Example request:

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"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Cassin and Sons"
        },
        {
            "id": null,
            "name": "Gusikowski, Stark and Renner"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Create new self-service store

POST

https://api.metapic.dev

/v2/stores

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Store name.

Example:

My Store

domains

string[]

Store domains. Must match the regex /^(https?:\/\/)?([\dA-Za-z.-]+).([A-Za-z.]{2,6})([\/\w .-])\/?$/.

Example:

[["dev.test-test.com"]]

PUT v2/stores/{store_id}/payment

PUT

https://api.metapic.dev

/v2/stores/{store_id}/payment

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

store_id

integer

required

The ID of the store.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/stores/8/payment" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Tag

GET v2/affiliate-links/{id}

GET

https://api.metapic.dev

/v2/affiliate-links/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the affiliate link.

Example:

debitis

Response Fields

status

The result of the affiliate link conversion.

The id of the affiliate link.

mtpc_url

URL

The shortened, public URL of the affiliate link.

advertiser

object

The advertiser associated with the affiliate link.

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/affiliate-links/debitis" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "url": "http://kuphal.net/et-quis-laudantium-incidunt",
    "original_url": "http://www.kunde.biz/et-voluptatibus-porro-rerum-qui-odio-quam.html",
    "user_id": 2694,
    "country": "CR",
    "provider": "lime",
    "advertiser": {
        "id": 1643,
        "name": "Boehm-Kunde"
    }
}

Uploads

Upload image

POST

https://api.metapic.dev

/v2/image-uploads

requires authentication

Uploads an image to tmp folder.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

image

string

required

Max size: 51200 kb. Allowed types: image/*.

Example:

sint

Response Fields

url

string

A pre-constructed, working URL to the image using a default configuration

base64

string

Image key (base64 encoded image path)

key

string

Image key (base64 encoded image path)

base_url

string

The base URL of imageproxy service. Required if url is missing

Auth

Headers

Body

{ "image": "sint" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/image-uploads" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"image\": \"sint\"
}"

User

List users

GET

https://api.metapic.dev

/v2/users

requires authentication

Endpoint for querying & sorting all users.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

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.

Example:

testcreator123

client_id

integer

Query by user's client. Returns all users which belong to the given client_id.

Example:

store_group_id

integer

Query by user's store group. Returns all users which belong to the given store_group_id.

Example:

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

sort_by

string

Example:

created_at:desc

Auth

Headers

Query Parameters

Received response

Example request:

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"

Example response:

{
    "data": [
        {
            "id": null,
            "username": "grussel",
            "email": "[email protected]",
            "client_id": 2717
        },
        {
            "id": null,
            "username": "sincere44",
            "email": "[email protected]",
            "client_id": 2718
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Match users by IDs and emails

POST

https://api.metapic.dev

/v2/match-users

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

advertiser_group_id

integer

Query by user's advertiser group. Returns all users which belong to the given advertiser_group_id.

Example:

user_emails_or_ids

object

required

a mix array of user emails and ids. Must not have more than 1000 items.

Example:

[12345,"[email protected]"]

Response Fields

matched_users

string[]

The result of matched users

unmatched_users

string[]

The result of unmatched users

Auth

Headers

Query Parameters

Received response

Example request:

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"

User Tag

List user tags

GET

https://api.metapic.dev

/v2/user-tags

requires authentication

Endpoint for querying & sorting all user tags.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

name

string

Query by user tag's name. Returns all user tags whose name contains the given name. Must not be greater than 255 characters.

Example:

favourites

store_id

integer

Query by user tag's store. Returns all user tags which belong to the given store_id.

Example:

access_levels

object

Query by user tag's access levels. Returns all user tags which have the given access_levels:

ACCESS_LEVEL_ADMIN = 0
ACCESS_LEVEL_ALL = 1
ACCESS_LEVEL_STORE = 2

Must be one of:

Example:

[0,1]

size

integer

Page size. Defaults to 20. Must not be greater than 100.

Example:

sort_by

string

Example:

created_at:desc

Auth

Headers

Query Parameters

Received response

Example request:

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"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Daija Lehner",
            "slug": "enim-est-in",
            "access_level": 1,
            "store_id": 1641
        },
        {
            "id": null,
            "name": "Waldo Emard",
            "slug": "voluptas-sed",
            "access_level": 1,
            "store_id": 1642
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}