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

Creator Blocklist

Manages the creator blocklist for an advertiser.

Creators added to the blocklist will not see the advertiser nor be able to convert links for that advertiser.

Gets the entries in the blocklist

GET

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/blocklist

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Query Parameters

query

string

Filters results to match user ID or username. Must not be greater than 128 characters.

Example:

omfhpglgtxnzw

Response Fields

created_at

date

required

The datetime blocklist target was created.

created_by

App\Http\Resources\User\UserResource

required

User Resource The user who created the blocklist target.

id - int Unique identifier of the campaign.
username - string The title of the campaign.
email - string The internal name of the campaign.
client_id - int The current amount of money used by the campaign, expressed in minor units (e.g., cents).

user_tag

App\Http\Resources\UserTag\UserTagResource

required

User Tag Blocklist target. This field is null if other target is specified.

user

App\Http\Resources\User\UserResource

required

User Blocklist target. This field is null if other target is specified.

validate_clicks

boolean

required

Indicates whether the blocklist User Target should block user clicks. Only present if user target is specified.

Auth

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/12/blocklist?query=omfhpglgtxnzw" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "created_at": null,
            "created_by": {
                "id": 3984,
                "username": "araceli15",
                "display_name": "Joshua Stroman",
                "email": "[email protected]",
                "client_id": 4211,
                "preferred_locale": "mn_MN",
                "language": "mn"
            },
            "client": {
                "id": 4212,
                "name": "Miss Kenna Runolfsdottir IV",
                "client_id": "lHzkGrN3uZ",
                "has_own_payment_system": false,
                "revenue_share": 1
            }
        },
        {
            "id": null,
            "created_at": null,
            "created_by": {
                "id": 3985,
                "username": "krogahn",
                "display_name": "Tressie Dickinson",
                "email": "[email protected]",
                "client_id": 4213,
                "preferred_locale": "da_DK",
                "language": "da"
            },
            "client": {
                "id": 4214,
                "name": "Prof. Aidan Ullrich",
                "client_id": "n5PIBtuD7s",
                "has_own_payment_system": false,
                "revenue_share": 1
            }
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

Add entries to the blocklist

POST

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/blocklist

requires authentication

Adds the given entries to the blocklist, ignoring them if they previously existed.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Body Parameters

users

object[]

Array of user objects to add, each with user ID and optional validate_clicks flag.

user_tag_ids

string[]

IDs of the user tags to add. The id of an existing record in the user_tags table.

Example:

[10]

client_ids

string[]

IDs of the client to add. The id of an existing record in the clients table.

Example:

[20]

Auth

Headers

URL Parameters

Body

{ "users": [ { "id": 13, "validate_clicks": true } ], "user_tag_ids": [ 10 ], "client_ids": [ 20 ] }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/advertisers/7/blocklist" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"users\": [
        {
            \"id\": 123,
            \"validate_clicks\": true
        },
        {
            \"id\": 456,
            \"validate_clicks\": false
        }
    ],
    \"user_tag_ids\": [
        10
    ],
    \"client_ids\": [
        20
    ]
}"

Remove the target in the advertiser blocklist

DELETE

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/blocklist/{target_id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

target_id

integer

required

The ID of the target.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

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

Order Collectors

Get settings for sales pixel implementation

GET

https://api.metapic.dev

/v2/advertisers/{advertiser}/order-collectors/sales-pixel

requires authentication

Returns the settings to be added to the sales pixel script.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser

string

required

The advertiser.

Example:

esse

Response Fields

latest_order_at

The date and time of the latest order collected through the sales pixel

Example:

2025-05-30T09:22:30.811924Z

test_order_url

A URL to be used for placing orders to test tracking

required

Example:

http://osinski.biz/omnis-error-quam-distinctio-enim.html

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/esse/order-collectors/sales-pixel" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

Get order collector tracking settings

GET

https://api.metapic.dev

/v2/advertisers/{advertiser}/order-collectors/{collector}

requires authentication

Returns the tracking configuration for the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser

string

required

The advertiser.

Example:

quia

collector

string

required

The identifier of the collector

Must be one of:

woocommerce

Example:

woocommerce

Response Fields

activation_key

The key for activating the collector plugin

required

Example:

683978d6c4d99

latest_order_at

The date and time of the latest order collected through the collector plugin

Example:

2025-05-30T09:22:30.811924Z

test_order_url

A URL to be used for placing orders to test tracking

required

Example:

http://osinski.biz/omnis-error-quam-distinctio-enim.html

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/quia/order-collectors/woocommerce" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

Activate tracking plugin

POST

https://api.metapic.dev

/v2/activate-tracking-plugin

Activates the tracking plugin with the given activation key.

Returns the parameters to insert into the Javascript tracking snippet.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

metapic_activation_key

string

required

The plugin's activation key, obtained from Advertiser App.

Example:

totam

Response Fields

organization_id

number

required

program_id

number

required

event_id

number

required

currency

string

required

Example:

EUR

Headers

Body

{ "metapic_activation_key": "totam" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/activate-tracking-plugin" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"metapic_activation_key\": \"totam\"
}"

Email quota

GET

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/email-quota

requires authentication

Returns remaining email quota for the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Response Fields

used

integer

required

Used email quota - emails sent by advertiser within 7 days window.

remaining

integer

required

Current remining weekly email quota.

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/10/email-quota" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

GET v2/advertisers/{advertiser_id}/payment-setup

GET

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/payment-setup

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/9/payment-setup" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

POST v2/advertisers/{advertiser_id}/payment-setup

POST

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/payment-setup

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Body Parameters

payment_setup_id

string

required

Example:

cumque

Auth

Headers

URL Parameters

Body

{ "payment_setup_id": "cumque" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/advertisers/5/payment-setup" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_setup_id\": \"cumque\"
}"

Create Advertiser Representative

POST

https://api.metapic.dev

/v2/advertiser-representatives

requires authentication

Creates a new Metapic user and self-service advertiser for the current session. Requires an Ory-issued JWT for a session not yet linked to a Metapic user (no metapic_user_id).

Headers

Authorization

Example:

Bearer {JWT}

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"]]

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

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:

dicta

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=dicta" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Monahan-Satterfield"
        },
        {
            "id": null,
            "name": "Roob-Nikolaus"
        }
    ],
    "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",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

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

GET

https://api.metapic.dev

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

requires authentication

deprecated:This endpoint is deprecated. Please use /users/{user}/advertisers

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/14/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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

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

GET

https://api.metapic.dev

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

requires authentication

deprecated:This endpoint is deprecated. Please use /users/{user}/advertisers

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/14/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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

List Creator Advertisers

GET

https://api.metapic.dev

/v2/users/{user_id}/advertisers

requires authentication

Returns list of advertisers with commission rates, campaigns, and other relevant information for the creator.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Query Parameters

category_id

integer

Filter by advertiser category. The ID of an existing record in the store_categories table. If not provided, returns recommended (toplist) advertisers. The id of an existing record in the store_categories table.

Example:

include

string[]

Include optional relationships in the response. Options: mainUrlMatchingRule, StoreCategories.

Must be one of:

mainUrlMatchingRule
StoreCategories

Example:

["StoreCategories"]

page

integer

Page number for pagination.

Example:

size

integer

Number of items per page. Defaults to 200. Must not be greater than 200.

Example:

200

Auth

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/users/14/advertisers?category_id=5&include[]=StoreCategories&page=1&size=200" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 2302,
            "name": "Nikolaus-Bruen",
            "traffic_sources_costs": [
                {
                    "source": 0,
                    "cpc": 100,
                    "cpc_v2": {
                        "amount": "1",
                        "currency": "SEK"
                    },
                    "cpa": 0.1,
                    "currency": "SEK"
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Accept invites for advertiser

PATCH

https://api.metapic.dev

/v2/me/advertiser-invites

requires authentication

Creates Metapic user and accepts all pending invites for advertiser

Headers

Authorization

Example:

Bearer {JWT}

Content-Type

Example:

application/json

Example:

application/json

Auth

Headers

Received response

Example request:

curl --request PATCH \
    "https://api.metapic.dev/v2/me/advertiser-invites" \
    --header "Authorization: Bearer {JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Url Matching Rules

Manages url matching rules for an advertiser. Url Matching rule can either be to allow or to block matching of a URL based on added rules.

List all url matching rules

GET

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/url-matching-rules

requires authentication

Returns all url matching rules defined for the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Response Fields

type

App\Enums\UrlMatchingType

required

The type of url matching rule, either "allow" or "block".

is_main

boolean

required

Indicates whether this is the main url matching rule for the advertiser. Each advertiser can have only one main rule, which is used as the default rule for URL matching and for navigating to the advertiser website.

url

string

required

The domain to be matched. Only present for type "block" if URL matching rule is used.

keyword

string

required

The keyword to be matched. Only present for type "block" if keyword matching rule is used. Optional for type "allow".

updated_at

date

required

When the rule was last updated.

updated_by

App\Http\Resources\User\UserResource

required

The user who last updated the rule.

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/5/url-matching-rules" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[
    {
        "id": null,
        "type": null,
        "is_main": null,
        "url": "testcompany.com",
        "updated_at": null
    },
    {
        "id": null,
        "type": null,
        "is_main": null,
        "url": "testcompany.com",
        "updated_at": null
    }
]

Add new url matching rule

POST

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/url-matching-rules

requires authentication

Adds a new rule to the url matching for the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Body Parameters

type

string

required

Must be one of:

allow
block

Example:

block

url

string

Must not be greater than 200 characters.

Example:

http://mohr.biz/qui-ratione-incidunt-iusto-eos-dolores-enim-et

keyword

string

Must match the regex /^[A-Za-z0-9_-=]+$/. Must not be greater than 30 characters.

Example:

wqtryx

is_main

boolean

Example:

true

Auth

Headers

URL Parameters

Body

{ "type": "block", "url": "http:\/\/mohr.biz\/qui-ratione-incidunt-iusto-eos-dolores-enim-et", "keyword": "wqtryx", "is_main": true }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/advertisers/2/url-matching-rules" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"block\",
    \"url\": \"http:\\/\\/mohr.biz\\/qui-ratione-incidunt-iusto-eos-dolores-enim-et\",
    \"keyword\": \"wqtryx\",
    \"is_main\": true
}"

Update url matching rule

PUT

PATCH

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/url-matching-rules/{urlMatchingRule_id}

requires authentication

Updates existing url matching rule for the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

urlMatchingRule_id

integer

required

The ID of the urlMatchingRule.

Example:

Body Parameters

type

string

required

Must be one of:

allow
block

Example:

block

url

string

Must not be greater than 200 characters.

Example:

http://www.berge.org/

keyword

string

Must match the regex /^[A-Za-z0-9_-=]+$/. Must not be greater than 30 characters.

Example:

fcmqzmadxrftsvyai

is_main

boolean

Example:

false

Auth

Headers

URL Parameters

Body

{ "type": "block", "url": "http:\/\/www.berge.org\/", "keyword": "fcmqzmadxrftsvyai", "is_main": false }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/advertisers/5/url-matching-rules/15" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"block\",
    \"url\": \"http:\\/\\/www.berge.org\\/\",
    \"keyword\": \"fcmqzmadxrftsvyai\",
    \"is_main\": false
}"

Remove url matching rule

DELETE

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/url-matching-rules/{urlMatchingRule_id}

requires authentication

Removes existing url matching rule for the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

urlMatchingRule_id

integer

required

The ID of the urlMatchingRule.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.metapic.dev/v2/advertisers/10/url-matching-rules/8" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Self-Service

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"]]

Deactivate advertiser

POST

https://api.metapic.dev

/v2/advertisers/{advertiser_id}/deactivate

requires authentication

Deactivates the advertiser.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser_id

integer

required

The ID of the advertiser.

Example:

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

App\Http\Resources\Store\StoreResource

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.

Example:

true

size

integer

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

Example:

sort_by

string

Example:

qui

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/advertiser-groups?return_ad_enabled=1&size=20&sort_by=qui" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

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

Affiliate Link

Get an affiliate link

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:

dolores

Response Fields

required

The id of the affiliate link.

mtpc_url

URL

required

The shortened, public URL of the affiliate link.

advertiser

object

required

The advertiser associated with the affiliate link.

title

string

The title of the affiliate link tag.

image

object

The image associated with the affiliate link tag.

created_at

datetime

When the affiliate link tag was created.

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

{
    "url": "http://www.feest.org/tempora-corporis-odit-eum-sint-maiores-dicta",
    "original_url": "http://stokes.org/eum-blanditiis-enim-dolores-explicabo-magnam",
    "user_id": 3992,
    "country": "BD",
    "provider": "gray",
    "advertiser": {
        "id": 2308,
        "name": "Beier LLC"
    },
    "title": "Zackary Metz"
}

Create an affiliate link

POST

https://api.metapic.dev

/v2/affiliate-links

requires authentication

deprecated:The endpoint for direct affiliate link creation is deprecated. Please use the inspect endpoint to check the convertibility of the URL and get matching advertisers, and then use the convert endpoint to create the affiliate link.

Returns advertisers if there are multiple advertisers to match the url with. Otherwise, returns the affiliate link.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

url

string

required

The original URL to be converted into an affiliate link. Must be a valid URL. Must match the regex /^[^\s]*$/. Must not be greater than 4096 characters.

Example:

https://advertiser.com

advertiser_id

integer

The specified advertiser ID for which the affiliate link will be created. The id of an existing record in the stores table.

Example:

advertiser_preview

boolean

Admin-only If enabled, the response will include a list of available advertisers for which an affiliate link can be created. No link will be created..

Example:

true

advertiser_group_id

integer

Admin-only The ID of the advertiser group to associate user with. The affiliate link will be linked to the specified group user. This field is required when advertiser_preview is true. The id of an existing record in the store_groups table.

Example:

dry

boolean

Indicates whether the link conversion should be dry (i.e. no link is created).

Example:

true

Response Fields

status

string

required

The result of the affiliate link conversion.

Example:

success

affiliate_link

object

required

The affiliate link.

advertisers

string[]

required

The convertible advertisers for which the affiliate link can be created.

Auth

Headers

Body

{ "url": "https:\/\/advertiser.com", "advertiser_id": 16, "advertiser_preview": true, "advertiser_group_id": 1, "dry": true }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/affiliate-links" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/advertiser.com\",
    \"advertiser_id\": 16,
    \"advertiser_preview\": true,
    \"advertiser_group_id\": 1,
    \"dry\": true
}"

Example response:

{
    "status": "success",
    "affiliate_link": {
        "status": "success",
        "url": "http://carter.net/sit-delectus-atque-voluptatem-error.html",
        "original_url": "http://mayer.com/suscipit-reprehenderit-non-sit-rerum-voluptatem",
        "user_id": 3993,
        "country": "CG",
        "provider": "green",
        "advertiser": {
            "id": 2309,
            "name": "Rippin, Grady and Balistreri"
        },
        "title": "Adan Pacocha Jr."
    }
}

Create an affiliate link

POST

https://api.metapic.dev

/v2/users/{user_id}/affiliate-links

requires authentication

Returns advertisers if there are multiple advertisers to match the url with. Otherwise, returns the affiliate link.

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

url

string

required

The original URL to be converted into an affiliate link. Must be a valid URL. Must match the regex /^[^\s]*$/. Must not be greater than 4096 characters.

Example:

https://advertiser.com

advertiser_id

integer

The specified advertiser ID for which the affiliate link will be created. The id of an existing record in the stores table.

Example:

advertiser_preview

boolean

Admin-only If enabled, the response will include a list of available advertisers for which an affiliate link can be created. No link will be created..

Example:

true

advertiser_group_id

integer

Example:

dry

boolean

Indicates whether the link conversion should be dry (i.e. no link is created).

Example:

false

Response Fields

status

string

required

The result of the affiliate link conversion.

Example:

success

affiliate_link

object

required

The affiliate link.

advertisers

string[]

required

The convertible advertisers for which the affiliate link can be created.

Auth

Headers

URL Parameters

Body

{ "url": "https:\/\/advertiser.com", "advertiser_id": 6, "advertiser_preview": true, "advertiser_group_id": 1, "dry": false }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/users/14/affiliate-links" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/advertiser.com\",
    \"advertiser_id\": 6,
    \"advertiser_preview\": true,
    \"advertiser_group_id\": 1,
    \"dry\": false
}"

Example response:

{
    "status": "success",
    "affiliate_link": {
        "status": "success",
        "url": "https://durgan.org/itaque-consequatur-deleniti-sed-dolorem.html",
        "original_url": "https://rolfson.info/autem-consequatur-porro-non-sunt-dolores-aut.html",
        "user_id": 3994,
        "country": "BO",
        "provider": "white",
        "advertiser": {
            "id": 2310,
            "name": "Morissette Inc"
        },
        "title": "Robin Wilderman"
    }
}

List affiliate links

GET

https://api.metapic.dev

/v2/affiliate-links

requires authentication

Returns a paginated list of affiliate links associated with the creator.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

user_id

integer

Filter affiliate links by creator (user) id. The id of an existing record in the users table.

Example:

456

advertiser_id

integer

Filter affiliate links by advertiser (store) id. The id of an existing record in the stores table.

Example:

123

date_from

string

Filter links created on or after this date (Y-m-d). Must be a valid date. Must be a date before or equal to date_to.

Example:

2024-01-01

date_to

string

Filter links created on or before this date (Y-m-d). Must be a valid date. Must be a date after or equal to date_from.

Example:

2024-01-31

include

string[]

Include related data. When "stats" is included, the response will contain clicks, earnings, and potential earnings, and allow sorting by clicks and earnings.

Must be one of:

stats
advertiser

Example:

["stats"]

sort_by

string

Available column names: clicks, earnings, created_at. 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

page

integer

Page number for pagination. Must be at least 1.

Example:

size

integer

Number of items per page. Defaults to 20. Must be at least 1. Must not be greater than 100.

Example:

Response Fields

required

The id of the affiliate link.

title

string

The title of the affiliate link, if available.

image

object

The image associated with the affiliate link, if available.

mtpc_url

URL

required

The shortened, public URL of the affiliate link.

user_id

integer

required

The id of the user who created the affiliate link.

created_at

datetime

required

The date and time when the affiliate link was created.

advertiser

object

The advertiser associated with the affiliate link.

stats

object

The statistics associated with the affiliate link.

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/affiliate-links?user_id=456&advertiser_id=123&date_from=2024-01-01&date_to=2024-01-31&include[]=stats&sort_by=created_at%3Adesc&page=1&size=15" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "title": "Tanner Armstrong V",
            "mtpc_url": null,
            "user_id": 3995,
            "created_at": null
        },
        {
            "id": null,
            "title": "Nellie Emard",
            "mtpc_url": null,
            "user_id": 3996,
            "created_at": 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",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Inspect Affiliate Link

POST

https://api.metapic.dev

/v2/users/{user_id}/inspections/affiliate-link

requires authentication

Determines convertibility of a URL, detects existing affiliate links, and returns matching advertisers when applicable.

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

url

string

required

The original URL to be converted into an affiliate link. Must be a valid URL. Must not be greater than 4096 characters.

Example:

https://advertiser.com

ignore_advertiser_visibility

boolean

Admin-only Whether to ignore advertiser visibility for the current user when inspecting an affiliate link.

Example:

true

Response Fields

inspection_result

required

Indicates the result of the affiliate link inspection.

Must be one of:

single_advertiser
multiple_advertisers
no_matching_advertisers
affiliate_link

Example:

single_advertiser

matching_advertisers

string[]

The convertible advertisers for which the affiliate link can be created.

Auth

Headers

URL Parameters

Body

{ "url": "https:\/\/advertiser.com", "ignore_advertiser_visibility": true }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/users/14/inspections/affiliate-link" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/advertiser.com\",
    \"ignore_advertiser_visibility\": true
}"

Example response:

{
            "inspection_result": "single_advertiser",
            "matching_advertisers": [
                {
                    "id": 123,
                    "name": "Advertiser Name",
                    "traffic_sources_costs": [
                        {
                            "id": 15,
                            "source": 0,
                            "cpc": 100,
                            "cpc_v2": {
                                "amount": "10",
                                "currency": "EUR"
                            },
                            "currency": "EUR"
                        }
                    ],
                    "... other StoreResource fields ... "
                }
            ]}

Convert an Affiliate Link

POST

https://api.metapic.dev

/v3/users/{user_id}/affiliate-links

requires authentication

It converts url to an affiliate link.

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

url

string

required

The original URL to be converted into an affiliate link. Must be a valid URL. Must not be greater than 4096 characters.

Example:

https://advertiser.com

advertiser_id

integer

The specified advertiser ID for which the affiliate link will be created. The id of an existing record in the stores table.

Example:

Response Fields

required

The id of the affiliate link.

mtpc_url

URL

required

The shortened, public URL of the affiliate link.

advertiser

object

required

The advertiser associated with the affiliate link.

title

string

The title of the affiliate link tag.

image

object

The image associated with the affiliate link tag.

created_at

datetime

When the affiliate link tag was created.

Auth

Headers

URL Parameters

Body

{ "url": "https:\/\/advertiser.com", "advertiser_id": 14 }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v3/users/14/affiliate-links" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"https:\\/\\/advertiser.com\",
    \"advertiser_id\": 14
}"

Example response:

{
    "url": "https://lind.org/consequatur-voluptatem-aliquam-laudantium-velit.html",
    "original_url": "http://www.roob.org/sapiente-velit-vel-et-eveniet",
    "user_id": 3998,
    "country": "CW",
    "provider": "green",
    "advertiser": {
        "id": 2314,
        "name": "Gutmann-Greenholt"
    },
    "title": "Darwin Grimes MD"
}

Agency

Accept invites for agency

PATCH

https://api.metapic.dev

/v2/me/agency-invites

requires authentication

Creates Metapic user and accepts all pending invites for agency

Headers

Authorization

Example:

Bearer {JWT}

Content-Type

Example:

application/json

Example:

application/json

Auth

Headers

Received response

Example request:

curl --request PATCH \
    "https://api.metapic.dev/v2/me/agency-invites" \
    --header "Authorization: Bearer {JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

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

query

string

Query by id or name. Returns all clients where id is equal to query OR name contains query OR any revenue tier name contains query. Must not be greater than 128 characters.

Example:

internal name

advertiser_group_ids

integer[]

Query by advertiser group. Returns all clients which belong to the given advertiser_group_ids.

Example:

[1]

size

integer

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

Example:

sort_by

string

Example:

rerum

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/clients?query=internal+name&advertiser_group_ids[]=1&size=20&sort_by=rerum" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 14,
            "name": "Gabrielle Bechtelar",
            "client_id": "qQX4Wt7QIo",
            "has_own_payment_system": false,
            "revenue_share": 1
        },
        {
            "id": 14,
            "name": "Gabrielle Bechtelar",
            "client_id": "qQX4Wt7QIo",
            "has_own_payment_system": false,
            "revenue_share": 1
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "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:

ipsa

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:

youtube

favorite

string

Filter user media by favorite value.

Must be one of:

all
1
0

Example:

all

group

integer

:shrug:.

Example:

format

string

Format to export.

Must be one of:

csv
xlsx
json

Example:

csv

Response Fields

media_type

string

required

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=ipsa&status=2&type=youtube&favorite=all&group=11&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 v2/health

GET

https://api.metapic.dev

/v2/health

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/health" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "status": "up"
}

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": "Fashion"
    },
    {
        "id": null,
        "name": "Food"
    }
]

Get all invoices for a payment period as a zip.

GET

POST

https://api.metapic.dev

/v2/payments/getPaymentInvoices

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

payment_period

string

required

Must be a valid date in the format Y-m.

Example:

2026-04

Auth

Headers

Body

{ "payment_period": "2026-04" }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/payments/getPaymentInvoices" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_period\": \"2026-04\"
}"

Example response:

Headers

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

{
    "message": "Unauthenticated."
}

Get Payments parts by user, grouped by months and stores

POST

https://api.metapic.dev

/v2/payments/upload-ax-id-matching

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

file

string

required

Must not be greater than 50000 characters.

Example:

hvxgszpbxdo

Auth

Headers

Body

{ "file": "hvxgszpbxdo" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/payments/upload-ax-id-matching" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"hvxgszpbxdo\"
}"

Mark Payments as paid

POST

https://api.metapic.dev

/v2/payments/mark-invoices-as-paid

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

file

string

required

Must not be greater than 50000 characters.

Example:

slnksnwabscfvenuaung

Auth

Headers

Body

{ "file": "slnksnwabscfvenuaung" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/payments/mark-invoices-as-paid" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"slnksnwabscfvenuaung\"
}"

Creator Invoice Generation

POST

https://api.metapic.dev

/v2/payments/generate-creator-invoice/{paymentId}

requires authentication

Endpoint for generating a creator invoice from external component

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

paymentId

string

required

Example:

nulla

Auth

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/payments/generate-creator-invoice/nulla" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

List PaymentSystemConfig

GET

https://api.metapic.dev

/v2/payments/systems-config

requires authentication

Endpoint for querying the current payment systems configuration

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

date

string

The payment date. Example: 2021-01-11. Must be a valid date.

Example:

2021-01-11

client_id

integer

Filter by client ID. The id of an existing record in the clients table.

Example:

user_id

integer

Filter by user ID. The id of an existing record in the users table.

Example:

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/payments/systems-config?date=2021-01-11&client_id=2&user_id=15" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

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

{
    "message": "Unauthenticated."
}

Update PaymentSystemConfig

POST

https://api.metapic.dev

/v2/payments/systems-config

requires authentication

Endpoint for updating the current payment systems configuration

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

date

string

Must be a valid date.

Example:

2026-04-21T11:54:03

client_id

integer

This field is required when user_id is not present. The id of an existing record in the clients table.

Example:

user_id

integer

This field is required when client_id is not present. The id of an existing record in the users table.

Example:

system

string

required

Must be one of:

Example:

ignore_lock

boolean

Example:

false

Auth

Headers

Body

{ "date": "2026-04-21T11:54:03", "client_id": 10, "user_id": 18, "system": 1, "ignore_lock": false }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/payments/systems-config" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2026-04-21T11:54:03\",
    \"client_id\": 10,
    \"user_id\": 18,
    \"system\": 1,
    \"ignore_lock\": false
}"

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:

admin

store_id

integer

This field is required when app is advertiser. The id of an existing record in the stores table.

Example:

Response Fields

indicators

object

Auth

Headers

Body

{ "app": "admin", "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\": \"admin\",
    \"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: *
access-control-expose-headers: Content-Disposition

{
    "message": "Unauthenticated."
}

Notification

Proxy any request to notification service

GET

POST

PUT

PATCH

DELETE

OPTIONS

https://api.metapic.dev

/v2/notifications-proxy/{path?}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

path

string

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/notifications-proxy/&lt;`" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "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:

suggestion

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.

Example:

true

has_onetime_payment

boolean

required

Whether the campaign offers a fixed fee for creators.

Example:

true

per_user_limit

boolean

required

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

Example:

false

one_time_payment

number

The fixed fee amount, if applicable. Sent as major unit amount (e.g. 30 for 30 EUR).

Example:

35326.445001

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:

2026-04-21T11:53:59

valid_until

string

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

Example:

1983-12-06

todo

string[]

Must not be greater than 255 characters.

Example:

["ytwfv"]

show_for_advertiser

boolean

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

Example:

false

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). The source of an existing record in the traffic_sources table.

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:

[20]

user_tag_ids

integer[]

Example:

[1]

store_group_ids

integer[]

Example:

[18]

emails

string[]

The value format is invalid.

Example:

["[email protected]"]

social_media_identifiers

string[]

Must not be greater than 30 characters.

Example:

["gawzzasljuqwybhhtlfusnu"]

client_ids

integer[]

Example:

[19]

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. The id of an existing record in the shared_budgets table.

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[]

required

Contains any warnings for creating campaign targets

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

URL Parameters

Body

{ "store_group_id": 11, "type": "suggestion", "name": "Summer campaign for VIP creators", "campaign_title": "Summer campaign", "campaign_text": "This is a summer campaign!", "has_product_seeding": true, "has_onetime_payment": true, "per_user_limit": false, "one_time_payment": 35326.445001, "budget_limit": 9, "max_clicks": 4, "valid_from": "2026-04-21T11:53:59", "valid_until": "1983-12-06", "todo": [ "ytwfv" ], "show_for_advertiser": false, "priority_after": 15, "traffic_sources_costs": [ { "source": 1, "cpc": 230, "cpa": 0.2, "invoice_cpc": 250, "invoice_cpa": 0.25, "user_revenue": 0 } ], "targets": { "user_ids": [ 20 ], "user_tag_ids": [ 1 ], "store_group_ids": [ 18 ], "emails": [ "[email protected]" ], "social_media_identifiers": [ "gawzzasljuqwybhhtlfusnu" ], "client_ids": [ 19 ], "revenue_tier_ids": [ 1 ] }, "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\": 11,
    \"type\": \"suggestion\",
    \"name\": \"Summer campaign for VIP creators\",
    \"campaign_title\": \"Summer campaign\",
    \"campaign_text\": \"This is a summer campaign!\",
    \"has_product_seeding\": true,
    \"has_onetime_payment\": true,
    \"per_user_limit\": false,
    \"one_time_payment\": 35326.445001,
    \"budget_limit\": 9,
    \"max_clicks\": 4,
    \"valid_from\": \"2026-04-21T11:53:59\",
    \"valid_until\": \"1983-12-06\",
    \"todo\": [
        \"ytwfv\"
    ],
    \"show_for_advertiser\": false,
    \"priority_after\": 15,
    \"shared_budget_id\": 1,
    \"shared_budget\": {
        \"title\": \"Summer budget\",
        \"amount\": 10000
    },
    \"targets\": {
        \"user_ids\": [
            20
        ],
        \"user_tag_ids\": [
            1
        ],
        \"store_group_ids\": [
            18
        ],
        \"emails\": [
            \"[email protected]\"
        ],
        \"social_media_identifiers\": [
            \"gawzzasljuqwybhhtlfusnu\"
        ],
        \"client_ids\": [
            19
        ],
        \"revenue_tier_ids\": [
            1
        ]
    },
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": 230,
            \"cpa\": 0.2,
            \"invoice_cpc\": 250,
            \"invoice_cpa\": 0.25,
            \"user_revenue\": 0
        }
    ]
}"

$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' => 11,
            'type' => 'suggestion',
            'name' => 'Summer campaign for VIP creators',
            'campaign_title' => 'Summer campaign',
            'campaign_text' => 'This is a summer campaign!',
            'has_product_seeding' => true,
            'has_onetime_payment' => true,
            'per_user_limit' => false,
            'one_time_payment' => 35326.445001,
            'budget_limit' => 9,
            'max_clicks' => 4,
            'valid_from' => '2026-04-21T11:53:59',
            'valid_until' => '1983-12-06',
            'todo' => [
                'ytwfv',
            ],
            'show_for_advertiser' => false,
            'priority_after' => 15,
            'shared_budget_id' => 1,
            'shared_budget' => [
                'title' => 'Summer budget',
                'amount' => 10000,
            ],
            'targets' => [
                'user_ids' => [
                    20,
                ],
                'user_tag_ids' => [
                    1,
                ],
                'store_group_ids' => [
                    18,
                ],
                'emails' => [
                    '[email protected]',
                ],
                'social_media_identifiers' => [
                    'gawzzasljuqwybhhtlfusnu',
                ],
                'client_ids' => [
                    19,
                ],
                'revenue_tier_ids' => [
                    1,
                ],
            ],
            'traffic_sources_costs' => [
                [
                    'source' => 1,
                    'cpc' => 230,
                    'cpa' => 0.2,
                    'invoice_cpc' => 250,
                    'invoice_cpa' => 0.25,
                    'user_revenue' => 0,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "data": {
        "id": null,
        "campaign_title": "Miss Bessie Lubowitz",
        "campaign_text": "Id minima amet soluta voluptates consequuntur deserunt voluptas et. Animi molestias asperiores expedita a eligendi. Nemo fugiat esse quibusdam qui.",
        "has_product_seeding": false,
        "has_onetime_payment": false,
        "status": "active",
        "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODAwP3RleHQ9Y3Vt",
        "image": null,
        "store_id": 2266,
        "token": "wki5wvkszo7ywl1x",
        "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

required

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

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": "Loy Brakus DDS",
    "campaign_text": "Reiciendis cumque architecto voluptatem ut nihil. Enim cumque sed aliquam qui asperiores fuga ut. Saepe inventore rerum inventore nemo nihil eos. Incidunt omnis aliquam deserunt aut.",
    "has_product_seeding": false,
    "has_onetime_payment": false,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA1NTMzP3RleHQ9ZXQ=",
    "image": null,
    "store_id": 2267,
    "token": "genwzl0gp8z5btw8",
    "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:

store_accept

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:

true

has_onetime_payment

boolean

required

Whether the campaign offers a fixed fee for creators.

Example:

false

per_user_limit

boolean

required

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

Example:

true

one_time_payment

number

The fixed fee amount, if applicable. Sent as major unit amount (e.g. 30 for 30 EUR).

Example:

1271511.462

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:

2026-04-21T11:53:59

valid_until

string

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

Example:

2012-08-21

todo

string[]

Must not be greater than 255 characters.

Example:

["bsqapmhh"]

show_for_advertiser

boolean

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

Example:

true

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). The source of an existing record in the traffic_sources table.

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:

[3]

user_tag_ids

integer[]

Example:

[14]

store_group_ids

integer[]

Example:

[5]

emails

string[]

The value format is invalid.

Example:

["[email protected]"]

social_media_identifiers

string[]

Must not be greater than 30 characters.

Example:

["izhflti"]

client_ids

integer[]

Example:

[13]

revenue_tier_ids

integer[]

Example:

[4]

shared_budget_id

string

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[]

required

Contains any warnings for updating campaign targets

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

URL Parameters

Body

{ "store_group_id": 8, "type": "store_accept", "name": "Summer campaign for VIP creators", "campaign_title": "Summer campaign", "campaign_text": "This is a summer campaign!", "has_product_seeding": true, "has_onetime_payment": false, "per_user_limit": true, "one_time_payment": 1271511.462, "budget_limit": 4, "max_clicks": 6, "valid_from": "2026-04-21T11:53:59", "valid_until": "2012-08-21", "todo": [ "bsqapmhh" ], "show_for_advertiser": true, "priority_after": 17, "traffic_sources_costs": [ { "source": 1, "cpc": 230, "cpa": 0.2, "invoice_cpc": 250, "invoice_cpa": 0.25, "user_revenue": 1 } ], "targets": [ { "user_ids": [ 3 ], "user_tag_ids": [ 14 ], "store_group_ids": [ 5 ], "emails": [ "[email protected]" ], "social_media_identifiers": [ "izhflti" ], "client_ids": [ 13 ], "revenue_tier_ids": [ 4 ] } ], "shared_budget_id": 1, "shared_budget": { "title": "Summer budget", "amount": 10000 } }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/offers/9" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"store_group_id\": 8,
    \"type\": \"store_accept\",
    \"name\": \"Summer campaign for VIP creators\",
    \"campaign_title\": \"Summer campaign\",
    \"campaign_text\": \"This is a summer campaign!\",
    \"has_product_seeding\": true,
    \"has_onetime_payment\": false,
    \"per_user_limit\": true,
    \"one_time_payment\": 1271511.462,
    \"budget_limit\": 4,
    \"max_clicks\": 6,
    \"valid_from\": \"2026-04-21T11:53:59\",
    \"valid_until\": \"2012-08-21\",
    \"todo\": [
        \"bsqapmhh\"
    ],
    \"show_for_advertiser\": true,
    \"priority_after\": 17,
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": 230,
            \"cpa\": 0.2,
            \"invoice_cpc\": 250,
            \"invoice_cpa\": 0.25,
            \"user_revenue\": 1
        }
    ],
    \"targets\": {
        \"0\": [],
        \"user_ids\": [
            3
        ],
        \"user_tag_ids\": [
            14
        ],
        \"store_group_ids\": [
            5
        ],
        \"emails\": [
            \"[email protected]\"
        ],
        \"social_media_identifiers\": [
            \"izhflti\"
        ],
        \"client_ids\": [
            13
        ],
        \"revenue_tier_ids\": [
            4
        ]
    },
    \"shared_budget_id\": 1,
    \"shared_budget\": {
        \"title\": \"Summer budget\",
        \"amount\": 10000
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.metapic.dev/v2/offers/9';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => '{accessToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'store_group_id' => 8,
            'type' => 'store_accept',
            'name' => 'Summer campaign for VIP creators',
            'campaign_title' => 'Summer campaign',
            'campaign_text' => 'This is a summer campaign!',
            'has_product_seeding' => true,
            'has_onetime_payment' => false,
            'per_user_limit' => true,
            'one_time_payment' => 1271511.462,
            'budget_limit' => 4,
            'max_clicks' => 6,
            'valid_from' => '2026-04-21T11:53:59',
            'valid_until' => '2012-08-21',
            'todo' => [
                'bsqapmhh',
            ],
            'show_for_advertiser' => true,
            'priority_after' => 17,
            'traffic_sources_costs' => [
                [
                    'source' => 1,
                    'cpc' => 230,
                    'cpa' => 0.2,
                    'invoice_cpc' => 250,
                    'invoice_cpa' => 0.25,
                    'user_revenue' => 1,
                ],
            ],
            'targets' => [
                [],
                'user_ids' => [
                    3,
                ],
                'user_tag_ids' => [
                    14,
                ],
                'store_group_ids' => [
                    5,
                ],
                'emails' => [
                    '[email protected]',
                ],
                'social_media_identifiers' => [
                    'izhflti',
                ],
                'client_ids' => [
                    13,
                ],
                'revenue_tier_ids' => [
                    4,
                ],
            ],
            '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": "Johathan Hamill",
        "campaign_text": "Quisquam tempora eos dolor est non beatae mollitia. Et soluta nisi aut et assumenda aut pariatur. Minima neque quisquam officiis esse ullam et. Sint doloremque quis id.",
        "has_product_seeding": false,
        "has_onetime_payment": false,
        "status": "active",
        "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9cXVpcw==",
        "image": null,
        "store_id": 2268,
        "token": "jsp93o9yyppr1osn",
        "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/10" \
    --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:

["active"]

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:

reiciendis

custom_sort_by

string

Must be one of:

ends_soon
active_first

Example:

ends_soon

include

object

format

string

Must be one of:

csv
xlsx

Example:

xlsx

show_for_advertiser

boolean

Admin-only filter offers by visibility on the advertiser.

Example:

true

advertiser_id

string

Filter offers by advertiser. Required when filtering as non-admin.

Example:

123

Response Fields

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers?query=black+friday&statuses[]=active&store_ids[]=1&store_group_ids[]=1&created_by=16&or_id=1234&target_user_id=7&size=20&sort_by=reiciendis&custom_sort_by=ends_soon&format=xlsx&show_for_advertiser=1&advertiser_id=123" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "campaign_title": "Jennifer Cartwright",
            "campaign_text": "Inventore dolorum voluptatem totam voluptatem tempore mollitia. Numquam ad quis laudantium cum ut odio. Qui qui quam tempore consequuntur.",
            "has_product_seeding": false,
            "has_onetime_payment": false,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODg4P3RleHQ9dm9sdXB0YXM=",
            "image": null,
            "store_id": 2269,
            "token": "jzdqtxqwm49w5yk0",
            "type": "standard"
        },
        {
            "id": null,
            "campaign_title": "Angelina Schumm",
            "campaign_text": "Hic vitae magnam aut commodi sint sequi rerum. Velit excepturi magnam hic. Et quis quae est. Qui autem et officiis fuga. Aliquam cumque mollitia consequatur voluptas provident magnam.",
            "has_product_seeding": false,
            "has_onetime_payment": false,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA5OTY2P3RleHQ9dXQ=",
            "image": null,
            "store_id": 2270,
            "token": "x7vvmjgixr7e3vfz",
            "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",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "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: 10MB kb. Allowed types: image/*.

Example:

culpa

Response Fields

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

URL Parameters

Body

{ "default": "culpa" }

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

Example response:

{
    "id": null,
    "campaign_title": "Arthur Fay",
    "campaign_text": "Modi quam sunt eligendi molestiae dicta enim repellendus. Earum minus culpa voluptatem est. Beatae molestiae repellat sed consequatur laudantium.",
    "has_product_seeding": false,
    "has_onetime_payment": false,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDc3P3RleHQ9ZWE=",
    "image": null,
    "store_id": 2271,
    "token": "f8vf9vvfz8jmxxbj",
    "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

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

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": "Roosevelt Ferry",
    "campaign_text": "Et consequatur rerum ab laboriosam. Molestiae placeat sequi maxime quam enim. In nesciunt non amet quam dolores distinctio.",
    "has_product_seeding": false,
    "has_onetime_payment": false,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDMzP3RleHQ9cmVwZWxsZW5kdXM=",
    "image": null,
    "store_id": 2272,
    "token": "z6rfagtqnhdl839a",
    "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

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

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": "Efrain Cummerata",
    "campaign_text": "Labore veritatis et et officia itaque laborum. Ipsam fugit nesciunt ipsam qui esse nobis. A sequi enim deleniti sit.",
    "has_product_seeding": false,
    "has_onetime_payment": false,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMTc3P3RleHQ9dm9sdXB0YXRlbQ==",
    "image": null,
    "store_id": 2273,
    "token": "0o0ug42kbpnzkvr1",
    "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:

2015-10-12

end_date

string

required

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

Example:

2069-01-10

Auth

Headers

URL Parameters

Query Parameters

Body

{ "start_date": "2015-10-12", "end_date": "2069-01-10" }

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\": \"2015-10-12\",
    \"end_date\": \"2069-01-10\"
}"

Example response:

Headers

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

{
    "message": "Unauthenticated."
}

Add affiliate link to campaign

PUT

https://api.metapic.dev

/v2/offers/{offer_id}/affiliate-links/{tag_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:

tag_id

integer

required

The ID of the tag.

Example:

offer

integer

required

The campaign (offer) ID.

Example:

456

tag

integer

required

The affiliate link (tag) ID.

Example:

123

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

[Empty response]

Remove affiliate link from campaign

DELETE

https://api.metapic.dev

/v2/offers/{offer_id}/affiliate-links/{tag_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:

tag_id

integer

required

The ID of the tag.

Example:

offer

integer

required

The campaign (offer) ID.

Example:

456

tag

integer

required

The affiliate link (tag) ID.

Example:

123

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

[Empty response]

Get User Campaigns

GET

https://api.metapic.dev

/v2/users/{user_id}/offers

requires authentication

Returns campaigns that are not of type "standard" with additional information about user participation. It also allows filtering by title, multiple campaign and participant statuses.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Query Parameters

status

string

DEPRECATED. Use statuses instead. Cannot be used together with statuses.

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

accepted

name

string

Filter campaigns by name. Must not be greater than 128 characters.

Example:

Nike

participant_statuses

string[]

Filter by multiple participant statuses.

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

["product_sent"]

campaign_statuses

string[]

Filter by multiple campaign statuses.

Must be one of:

active
scheduled

Example:

["scheduled"]

page

integer

Page number for pagination.

Example:

size

integer

Number of items per page. Defaults to 30. Must not be greater than 100.

Example:

Response Fields

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/users/14/offers?status=accepted&name=Nike&participant_statuses[]=product_sent&campaign_statuses[]=scheduled&page=1&size=30" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "campaign_title": "Lorenza Dare",
            "campaign_text": "Ea laborum molestiae alias non. Ab consequatur dignissimos ex minus ut. Omnis rerum omnis sed rerum. Reprehenderit nisi recusandae fuga.",
            "has_product_seeding": false,
            "has_onetime_payment": false,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMGZmP3RleHQ9YWRpcGlzY2k=",
            "image": null,
            "store_id": 2304,
            "token": "2p0sl8b8609myh7f",
            "type": "standard"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Get User Campaigns

GET

https://api.metapic.dev

/v2/users/{user_id}/campaigns

requires authentication

Returns campaigns that are not of type "standard" with additional information about user participation. It also allows filtering by title, multiple campaign and participant statuses.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Query Parameters

status

string

DEPRECATED. Use statuses instead. Cannot be used together with statuses.

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

accepted

name

string

Filter campaigns by name. Must not be greater than 128 characters.

Example:

Nike

participant_statuses

string[]

Filter by multiple participant statuses.

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

["second_prio"]

campaign_statuses

string[]

Filter by multiple campaign statuses.

Must be one of:

active
scheduled

Example:

["active"]

page

integer

Page number for pagination.

Example:

size

integer

Number of items per page. Defaults to 30. Must not be greater than 100.

Example:

Response Fields

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/users/14/campaigns?status=accepted&name=Nike&participant_statuses[]=second_prio&campaign_statuses[]=active&page=1&size=30" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "campaign_title": "Rey Dicki",
            "campaign_text": "Autem neque quis consequatur totam. Totam et dicta quia molestiae provident neque facere. Aut excepturi repellendus et dolores libero nihil. Saepe omnis quasi excepturi.",
            "has_product_seeding": false,
            "has_onetime_payment": false,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAxMWFhP3RleHQ9ZGVsZWN0dXM=",
            "image": null,
            "store_id": 2306,
            "token": "ap5zav90yjwdv8jw",
            "type": "standard"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

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:

nihil

offer_id

integer

required

The offer ID

Example:

15556

Response Fields

warnings

Contains any warnings when creating campaign targets

required

integer

required

The ID of the campaign.

campaign_title

string

required

The title of the campaign.

campaign_text

string

required

The text of the campaign.

has_product_seeding

boolean

required

Whether the campaign has product seeding enabled.

has_onetime_payment

boolean

required

Whether the campaign has a one-time payment.

one_time_payment

string

DEPRECATED. Use one_time_payment_v2 instead. The one-time payment amount of the campaign.

status

enum

required

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

paused_at

string

required

The timestamp when the campaign was paused, or null if it is not paused.

image_url

string

required

DEPRECATED. Use image instead. The URL of the campaign image.

image

object

required

The campaign image.

store_id

integer

required

The ID of the store associated with the campaign.

store_name

string

The name of the store associated with the campaign.

store_logo_url

string

DEPRECATED. Use store_logo instead. The URL of the store logo associated with the campaign.

store_logo

object

The store logo associated with the campaign.

currency

string

The currency ISO code of the store associated with the campaign.

one_time_payment_v2

string

The one-time payment amount of the campaign in the store currency.

token

string

required

The token of the campaign, used for authentication in some cases.

traffic_sources_costs

string[]

The costs associated with the traffic sources for this campaign.

type

enum

required

The type of the campaign.

budget_limit

string

The budget limit of the campaign.

consumed_budget

string

The consumed budget of the campaign.

author_id

integer

The ID of the user who created the campaign.

created_at

string

The timestamp when the campaign was created.

updated_at

string

The timestamp when the campaign was last updated.

priority

integer

The priority of the campaign.

show_for_advertiser

boolean

Whether the campaign is shown to the advertiser.

name

string

The name of the campaign.

store_group_id

integer

The ID of the store group associated with the campaign.

shared_budget

object

The shared budget associated with the campaign.

targets

object

The targets associated with the campaign.

constraints

object

The constraints of the campaign for the authenticated user.

todo

object

The to-do item associated with the campaign for the authenticated user.

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

{
    "id": null,
    "campaign_title": "Jackeline Zulauf",
    "campaign_text": "Velit aut rerum illum hic ut aut. Quae est nihil molestiae nihil similique corrupti. Pariatur praesentium et aliquid. Similique eum exercitationem et illum beatae vel.",
    "has_product_seeding": false,
    "has_onetime_payment": false,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA2Njk5P3RleHQ9c2ludA==",
    "image": null,
    "store_id": 2313,
    "token": "c4wsn0t6m1pyjuiz",
    "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[]

required

store_group_ids

string[]

required

user_tag_ids

string[]

required

client_ids

string[]

required

revenue_tier_ids

string[]

required

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: *
access-control-expose-headers: Content-Disposition

{
    "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:

[8]

user_tag_ids

integer[]

Example:

[15]

store_group_ids

integer[]

Example:

[15]

emails

string[]

The value format is invalid.

Example:

["[email protected]"]

social_media_identifiers

string[]

Must not be greater than 30 characters.

Example:

["tmqvikirtcdmocnqejahzrce"]

client_ids

integer[]

Example:

[12]

revenue_tier_ids

integer[]

Example:

[7]

Response Fields

user_ids

string[]

required

store_group_ids

string[]

required

user_tag_ids

string[]

required

client_ids

string[]

required

revenue_tier_ids

string[]

required

warnings

Contains any warnings when adding targets

required

Auth

Headers

URL Parameters

Body

{ "user_ids": [ 8 ], "user_tag_ids": [ 15 ], "store_group_ids": [ 15 ], "emails": [ "[email protected]" ], "social_media_identifiers": [ "tmqvikirtcdmocnqejahzrce" ], "client_ids": [ 12 ], "revenue_tier_ids": [ 7 ] }

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\": [
        8
    ],
    \"user_tag_ids\": [
        15
    ],
    \"store_group_ids\": [
        15
    ],
    \"emails\": [
        \"[email protected]\"
    ],
    \"social_media_identifiers\": [
        \"tmqvikirtcdmocnqejahzrce\"
    ],
    \"client_ids\": [
        12
    ],
    \"revenue_tier_ids\": [
        7
    ]
}"

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/13/users/14" \
    --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: *
access-control-expose-headers: Content-Disposition

{
    "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:

aibum

status

string

Must be one of:

open
applied
denied
accepted
store_denied
done
suggestion
second_prio
have_posted
have_received
product_sent

Example:

product_sent

include

string[]

Must be one of:

offer_comments_count
has_unread_notifications

Example:

["offer_comments_count"]

Response Fields

offer_comments_count

The number of comments on this participation.

required

integer

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Body

{ "query": "aibum", "status": "product_sent", "include": [ "offer_comments_count" ] }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/13/participants" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"aibum\",
    \"status\": \"product_sent\",
    \"include\": [
        \"offer_comments_count\"
    ]
}"

Example response:

{
    "data": [
        {
            "id": null,
            "offer_id": 814,
            "user_id": null,
            "display_name": "tjacobs",
            "clicks": 562,
            "status": "have_received",
            "pre_registered_identifier": "tjacobs",
            "todo": null,
            "payment_amount": null
        },
        {
            "id": null,
            "offer_id": 815,
            "user_id": 3952,
            "display_name": null,
            "clicks": 3154242,
            "status": "accepted",
            "todo": null,
            "payment_amount": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

{
    "id": null,
    "offer_id": 816,
    "user_id": 3955,
    "display_name": "[email protected]",
    "clicks": 52604370,
    "status": "open",
    "todo": null,
    "payment_amount": null
}

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:

hwtanapjhwtqvctpdtcoohvo

active

boolean

required

Example:

true

start_date

string

required

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

Example:

2012-01-05

end_date

string

required

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

Example:

2080-03-07

sort_by

string

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

Example:

clicks:desc

Response Fields

integer

required

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

required

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

required

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

required

The number of links created for this participant

clicks

integer

required

The number of clicks left for this participant

estimated_gp

number

required

The estimated GP for this participant

estimated_earning_to_cost_ratio

number

required

The estimated earning to cost ratio for this participant

Auth

Headers

URL Parameters

Body

{ "query": "hwtanapjhwtqvctpdtcoohvo", "active": true, "start_date": "2012-01-05", "end_date": "2080-03-07", "sort_by": "clicks:desc" }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/3/participants-stats" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"hwtanapjhwtqvctpdtcoohvo\",
    \"active\": true,
    \"start_date\": \"2012-01-05\",
    \"end_date\": \"2080-03-07\",
    \"sort_by\": \"clicks:desc\"
}"

Example response:

{
    "data": [
        {
            "id": null,
            "user_id": null,
            "display_name": "vaughn.veum",
            "clicks": 0,
            "status": "have_posted",
            "links_created": null,
            "estimated_gp": null,
            "estimated_earning_to_cost_ratio": null
        },
        {
            "id": null,
            "user_id": 3957,
            "display_name": null,
            "clicks": 0,
            "status": "store_denied",
            "links_created": null,
            "estimated_gp": null,
            "estimated_earning_to_cost_ratio": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "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:

2000-03-08

end_date

string

required

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

Example:

2028-07-01

Auth

Headers

URL Parameters

Body

{ "start_date": "2000-03-08", "end_date": "2028-07-01" }

Received response

Example request:

curl --request GET \
    --get "https://api.metapic.dev/v2/offers/15/participants-count-by-click-activity" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2000-03-08\",
    \"end_date\": \"2028-07-01\"
}"

Example response:

Headers

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

{
    "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

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Body

{ "status": "denied" }

Received response

Example request:

curl --request PATCH \
    "https://api.metapic.dev/v2/offers/14/participants/1/update-status" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"denied\"
}"

Example response:

{
    "id": null,
    "offer_id": 819,
    "user_id": 3959,
    "display_name": null,
    "clicks": 19039,
    "status": "accepted",
    "todo": null,
    "payment_amount": null
}

Update participant todo

PATCH

https://api.metapic.dev

/v2/offers/{offer_id}/participants/{participant_id}/todo

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

todo

object[]

required

Response Fields

integer

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Body

{ "todo": [ { "key": "qakjecfuqc", "value": true } ] }

Received response

Example request:

curl --request PATCH \
    "https://api.metapic.dev/v2/offers/19/participants/9/todo" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"todo\": [
        {
            \"key\": \"qakjecfuqc\",
            \"value\": true
        }
    ]
}"

Example response:

{
    "id": null,
    "offer_id": 820,
    "user_id": null,
    "display_name": "mills.gay",
    "clicks": 8878,
    "status": "applied",
    "pre_registered_identifier": "mills.gay",
    "todo": null,
    "payment_amount": null
}

Update participant payment amount

PUT

https://api.metapic.dev

/v2/offers/{offer_id}/participants/{participant_id}/payment-amount

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

payment_amount

object

A monetary object that represents the total amount of money this participant gets paid for the campaign.

Example:

{"amount":"1.2","currency":"EUR"}

Response Fields

integer

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Body

{ "payment_amount": { "amount": "1.2", "currency": "EUR" } }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/offers/9/participants/18/payment-amount" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_amount\": {
        \"amount\": \"1.2\",
        \"currency\": \"EUR\"
    }
}"

Example response:

{
    "id": null,
    "offer_id": 821,
    "user_id": null,
    "display_name": "lpurdy",
    "clicks": 400791,
    "status": "product_sent",
    "pre_registered_identifier": "lpurdy",
    "todo": null,
    "payment_amount": null
}

Set/override click limit

PATCH

https://api.metapic.dev

/v2/offers/{offer_id}/participants/{participant_id}/overrides/clicks

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

click_limit

integer

Example:

Response Fields

integer

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Body

{ "click_limit": 3 }

Received response

Example request:

curl --request PATCH \
    "https://api.metapic.dev/v2/offers/10/participants/6/overrides/clicks" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"click_limit\": 3
}"

Example response:

{
    "id": null,
    "offer_id": 822,
    "user_id": null,
    "display_name": "[email protected]",
    "clicks": 217498,
    "status": "open",
    "pre_registered_email": "[email protected]",
    "todo": null,
    "payment_amount": null
}

Override campaign's costs

PATCH

https://api.metapic.dev

/v2/offers/{offer_id}/participants/{participant_id}/overrides/costs

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

traffic_sources_costs

object[]

Array of traffic sources costs to override the ones set from the campaign.

Response Fields

integer

required

The unique id of this participant

offer_id

integer

required

The id of the offer for this participant

display_name

string

required

The name of the participant

clicks

integer

required

The number of clicks left for this participant

status

string

required

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

tags

array|null

List of user tags, if available

payment_amount

int|null

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a major unit amount (e.g. 30 for 30 EUR)

payment_amount_v2

object

The total amount of money this participant gets paid for the campaign. It differs from the campaign fee, if present. Sent as a monetary object

Auth

Headers

URL Parameters

Body

{ "traffic_sources_costs": [ { "source": 1, "cpc": { "amount": "1.2", "currency": "EUR" }, "cpa": 0.2 } ] }

Received response

Example request:

curl --request PATCH \
    "https://api.metapic.dev/v2/offers/8/participants/9/overrides/costs" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": {
                \"amount\": \"1.2\",
                \"currency\": \"EUR\"
            },
            \"cpa\": 0.2
        }
    ]
}"

Example response:

{
    "id": null,
    "offer_id": 823,
    "user_id": 3964,
    "display_name": null,
    "clicks": 2,
    "status": "suggestion",
    "todo": null,
    "payment_amount": null
}

Checks if user has been added to the offer.

GET

https://api.metapic.dev

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

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_token

string

required

Example:

omnis

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/offer-by-token/omnis/users/14" \
    --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: *
access-control-expose-headers: Content-Disposition
set-cookie: metapic_session=eyJpdiI6Ikxkazh3K1V6bjdBOHBkZUthcnl1U1E9PSIsInZhbHVlIjoiQTRGbS84L2hROEU0a0hOOVp3NFFVMDEvVjR6a1VhS1RCcjJCbFV2U2dHelI1R1RmL2RyNVpNUU5SZnd5MFJWMHl5d2gycjBZZzRmWUhUWnVPNmhDbW5DTEkxbDVMbVVZeGJIbG5WYXhHalJWRmxucXpMT1FCT3h2RGJEMW9CakwiLCJtYWMiOiJkYTRiNTYxZDNhYjY3Y2RmMGE3MThlYjljZjkyMjcxNDA2ZjViZWVjYzA3ZTA5NjBlOGRlMjk1NDcwYjhiYjVkIiwidGFnIjoiIn0%3D; expires=Tue, 21 Apr 2026 11:54:03 GMT; Max-Age=7200; path=/; secure; 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:

impedit

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/impedit/users/14/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:

nesybkitu

Auth

Headers

URL Parameters

Body

{ "comment": "nesybkitu" }

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

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:

Auth

Headers

URL Parameters

Body

{ "comment": "vj" }

Received response

Example request:

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

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/9" \
    --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/{offer_user}/activities

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

offer_user

string

required

Example:

quia

Body Parameters

include

string[]

Must be one of:

has_unread_notification

Example:

["has_unread_notification"]

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

Body

{ "include": [ "has_unread_notification" ] }

Received response

Example request:

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

Example response:

Headers

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

{
    "message": "Unauthenticated."
}

Ory

Identity Created

POST

https://api.metapic.dev

/v2/webhooks/ory/identities/created

Creates a Hubspot deal for advertiser representative when triggered by an Ory registration.after webhook.

Headers

mtpc-api-key

Example:

{mtpc-api-key}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

identity

object

required

The identity object from Ory.

string

required

The unique Ory identity ID.

Example:

ory_identity_id_123

traits

object

required

The traits object containing user information.

app_url

string

The application url from which the identity was created. Must be a valid URL.

Example:

https://advertiser.metapic.com

Headers

Body

{ "identity": { "id": "ory_identity_id_123", "traits": { "email": "[email protected]" } }, "app_url": "https:\/\/advertiser.metapic.com" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/webhooks/ory/identities/created" \
    --header "mtpc-api-key: {mtpc-api-key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identity\": {
        \"id\": \"ory_identity_id_123\",
        \"traits\": {
            \"email\": \"[email protected]\"
        }
    },
    \"app_url\": \"https:\\/\\/advertiser.metapic.com\"
}"

Example response:

[Empty response]

Identity updated

POST

https://api.metapic.dev

/v2/webhooks/ory/identities/updated

Updates a user when triggered by an Ory settings.after webhook.

Headers

mtpc-api-key

Example:

{mtpc-api-key}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

identity

object

required

The identity object from Ory.

string

required

The unique Ory identity ID.

Example:

ory_identity_id_123

traits

object

required

The traits object containing user information.

Headers

Body

{ "identity": { "id": "ory_identity_id_123", "traits": { "email": "[email protected]" } } }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/webhooks/ory/identities/updated" \
    --header "mtpc-api-key: {mtpc-api-key}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identity\": {
        \"id\": \"ory_identity_id_123\",
        \"traits\": {
            \"email\": \"[email protected]\"
        }
    }
}"

Example response:

[Empty response]

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:

["paused"]

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
conversion_rate:asc
conversion_rate:desc

Example:

current_clicks:asc

Response Fields

name

string

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, conversion_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[]=paused&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": "Hanna Langworth DVM",
            "advertiser_group_id": 4939,
            "affiliate_link": {
                "id": 883,
                "url": "http://padberg.com/et-ex-dignissimos-non-consectetur-eum.html",
                "original_url": "http://kozey.net/aut-necessitatibus-corporis-rerum-autem.html",
                "mtpc_url": "https://c.mtpc.se/883",
                "user_id": 3966,
                "country": "BW",
                "provider": "yellow",
                "advertiser": {
                    "id": 2289,
                    "name": "Adams PLC"
                },
                "title": "Jeramy Macejkovic",
                "created_at": "2026-04-21T11:54:02+02:00"
            },
            "author_id": 3967,
            "display_for_all_advertisers": false,
            "status": "active",
            "styles": null,
            "image": null,
            "starts_at": "2026-03-21T10:54:02.102822Z",
            "ends_at": "2026-05-21T09:54:02.102896Z",
            "stats": []
        },
        {
            "id": null,
            "name": "Antone Pouros",
            "advertiser_group_id": 4942,
            "affiliate_link": {
                "id": 884,
                "url": "http://ferry.com/",
                "original_url": "http://www.gutkowski.com/ut-dolores-occaecati-ipsam.html",
                "mtpc_url": "https://c.mtpc.se/884",
                "user_id": 3968,
                "country": "TV",
                "provider": "navy",
                "advertiser": {
                    "id": 2290,
                    "name": "Rogahn, Kihn and Rogahn"
                },
                "title": "Mekhi Jacobs",
                "created_at": "2026-04-21T11:54:02+02:00"
            },
            "author_id": 3969,
            "display_for_all_advertisers": false,
            "status": "active",
            "styles": null,
            "image": null,
            "starts_at": "2026-03-21T10:54:02.132390Z",
            "ends_at": "2026-05-21T09:54:02.132466Z",
            "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",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "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:

upudoxe

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs. The id of an existing record in the store_groups table.

Example:

advertiser_id

integer

required

The ID of the advertiser for which the affiliate link will be created. The id of an existing record in the stores table.

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.

Example:

false

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. The id of an existing record in the stores table.

Example:

[1]

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. The id of an existing record in the store_categories table.

Example:

[12]

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:

2026-04-21T11:54:02

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:

2077-04-20

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

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

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

Auth

Headers

Body

{ "name": "upudoxe", "advertiser_group_id": 8, "advertiser_id": 17, "return_link": "https:\/\/advertiser.com", "display_for_all_advertisers": false, "advertiser_ids": [ 1 ], "advertiser_category_ids": [ 12 ], "styles": { "color": "#ffffff" }, "image_key": "dG1wL2ltYWdlLmpwZw==", "starts_at": "2026-04-21T11:54:02", "ends_at": "2077-04-20", "click_limit": 11, "view_limit": 9 }

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\": \"upudoxe\",
    \"advertiser_group_id\": 8,
    \"advertiser_id\": 17,
    \"return_link\": \"https:\\/\\/advertiser.com\",
    \"display_for_all_advertisers\": false,
    \"advertiser_ids\": [
        1
    ],
    \"advertiser_category_ids\": [
        12
    ],
    \"styles\": {
        \"color\": \"#ffffff\"
    },
    \"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
    \"starts_at\": \"2026-04-21T11:54:02\",
    \"ends_at\": \"2077-04-20\",
    \"click_limit\": 11,
    \"view_limit\": 9
}"

Example response:

{
    "id": null,
    "name": "Elvie Fay",
    "advertiser_group_id": 4945,
    "affiliate_link": {
        "id": 885,
        "url": "http://www.mills.com/vel-iusto-sunt-debitis-nesciunt-suscipit-debitis",
        "original_url": "http://hegmann.info/at-sunt-numquam-et-sint-culpa",
        "mtpc_url": "https://c.mtpc.se/885",
        "user_id": 3970,
        "country": "CU",
        "provider": "green",
        "advertiser": {
            "id": 2291,
            "name": "Prohaska, Dicki and Kiehn"
        },
        "title": "Annabell Fisher",
        "created_at": "2026-04-21T11:54:02+02:00"
    },
    "author_id": 3971,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2026-03-21T10:54:02.180503Z",
    "ends_at": "2026-05-21T09:54:02.180604Z",
    "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

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, conversion_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/12" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "name": "Odell Brekke Jr.",
    "advertiser_group_id": 4948,
    "affiliate_link": {
        "id": 886,
        "url": "http://damore.info/",
        "original_url": "http://bode.com/velit-quod-esse-officiis-aliquam-odio-suscipit-accusamus",
        "mtpc_url": "https://c.mtpc.se/886",
        "user_id": 3972,
        "country": "GH",
        "provider": "yellow",
        "advertiser": {
            "id": 2292,
            "name": "Crooks, McKenzie and Stokes"
        },
        "title": "Jonas Shanahan",
        "created_at": "2026-04-21T11:54:02+02:00"
    },
    "author_id": 3973,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2026-03-21T10:54:02.217409Z",
    "ends_at": "2026-05-21T09:54:02.217482Z",
    "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:

mgks

advertiser_group_id

string

The advertiser group to which the Return Ad belongs.

advertiser_id

string

The ID of the advertiser for which the affiliate link will be created.

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.

Example:

true

advertiser_ids

integer[]

Example:

[6]

advertiser_category_ids

integer[]

Example:

[15]

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:

2026-04-21T11:54:02

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:

2112-07-28

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

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

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

Auth

Headers

URL Parameters

Body

{ "name": "mgks", "advertiser_group_id": null, "advertiser_id": null, "return_link": "https:\/\/advertiser.com", "display_for_all_advertisers": true, "advertiser_ids": [ 6 ], "advertiser_category_ids": [ 15 ], "styles": { "color": "#ffffff" }, "image_key": "dG1wL2ltYWdlLmpwZw==", "starts_at": "2026-04-21T11:54:02", "ends_at": "2112-07-28", "click_limit": 14, "view_limit": 19 }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/return-ads/9" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"mgks\",
    \"return_link\": \"https:\\/\\/advertiser.com\",
    \"display_for_all_advertisers\": true,
    \"advertiser_ids\": [
        6
    ],
    \"advertiser_category_ids\": [
        15
    ],
    \"styles\": {
        \"color\": \"#ffffff\"
    },
    \"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
    \"starts_at\": \"2026-04-21T11:54:02\",
    \"ends_at\": \"2112-07-28\",
    \"click_limit\": 14,
    \"view_limit\": 19
}"

Example response:

{
    "id": null,
    "name": "Nella Walter",
    "advertiser_group_id": 4951,
    "affiliate_link": {
        "id": 887,
        "url": "http://www.bosco.com/soluta-cupiditate-natus-et-sint",
        "original_url": "http://www.lubowitz.org/sint-earum-ea-libero",
        "mtpc_url": "https://c.mtpc.se/887",
        "user_id": 3974,
        "country": "FR",
        "provider": "purple",
        "advertiser": {
            "id": 2293,
            "name": "Leffler, Steuber and Lehner"
        },
        "title": "Dr. Romaine Greenholt",
        "created_at": "2026-04-21T11:54:02+02:00"
    },
    "author_id": 3975,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2026-03-21T10:54:02.256871Z",
    "ends_at": "2026-05-21T09:54:02.256943Z",
    "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/17" \
    --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

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, conversion_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/10/pause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "name": "Mrs. Kallie Grady",
    "advertiser_group_id": 4954,
    "affiliate_link": {
        "id": 888,
        "url": "http://www.ebert.com/",
        "original_url": "http://www.price.net/nostrum-modi-voluptatum-eveniet-eum-tempore-officiis-amet",
        "mtpc_url": "https://c.mtpc.se/888",
        "user_id": 3976,
        "country": "TF",
        "provider": "yellow",
        "advertiser": {
            "id": 2294,
            "name": "Fritsch, Paucek and Balistreri"
        },
        "title": "Alec Little",
        "created_at": "2026-04-21T11:54:02+02:00"
    },
    "author_id": 3977,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2026-03-21T10:54:02.297297Z",
    "ends_at": "2026-05-21T09:54:02.297386Z",
    "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

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, conversion_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/16/unpause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "name": "Jermain Lindgren",
    "advertiser_group_id": 4957,
    "affiliate_link": {
        "id": 889,
        "url": "https://www.mosciski.com/reiciendis-animi-iste-itaque-dolores",
        "original_url": "http://fisher.com/enim-et-molestias-qui-omnis-voluptas-id-at.html",
        "mtpc_url": "https://c.mtpc.se/889",
        "user_id": 3978,
        "country": "AL",
        "provider": "silver",
        "advertiser": {
            "id": 2295,
            "name": "Hayes-D'Amore"
        },
        "title": "Dr. Tyrell Hodkiewicz",
        "created_at": "2026-04-21T11:54:02+02:00"
    },
    "author_id": 3979,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2026-03-21T10:54:02.332379Z",
    "ends_at": "2026-05-21T09:54:02.332453Z",
    "stats": []
}

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

required

Internal name

advertiser_group_id

integer

required

The advertiser group to which the Return Ad belongs

affiliate_link

object

required

The affiliate link for the Return Ad.

author_id

integer

required

The id of Return Ad author

display_for_all_advertisers

boolean

required

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

required

An object of style attributes for the Return Ad.

image

object

The image for the Return Ad.

status

App\Enums\ReturnAdStatus

required

The status of the return ad.

starts_at

date

required

The start datetime for when the Return Ad becomes active.

ends_at

date

required

The end datetime for when the Return Ad is deactivated.

click_limit

integer

required

The click limit of the Return Ad.

view_limit

integer

required

The view limit of the Return Ad.

stats

object

required

An object that return stats for the Return Ad. These include (current_views, current_clicks, click_through_rate, conversion_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/11/return-ads" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[
    {
        "id": null,
        "name": "May Feil",
        "advertiser_group_id": 4960,
        "affiliate_link": {
            "id": 890,
            "url": "http://hintz.net/autem-sed-qui-aliquam-delectus-aspernatur-quisquam.html",
            "original_url": "http://www.cummerata.com/",
            "mtpc_url": "https://c.mtpc.se/890",
            "user_id": 3980,
            "country": "BN",
            "provider": "navy",
            "advertiser": {
                "id": 2296,
                "name": "Mann PLC"
            },
            "title": "Elisha Grimes Jr.",
            "created_at": "2026-04-21T11:54:02+02:00"
        },
        "author_id": 3981,
        "display_for_all_advertisers": false,
        "status": "active",
        "styles": null,
        "image": null,
        "starts_at": "2026-03-21T10:54:02.365987Z",
        "ends_at": "2026-05-21T09:54:02.366055Z",
        "stats": []
    },
    {
        "id": null,
        "name": "Loraine Morissette",
        "advertiser_group_id": 4963,
        "affiliate_link": {
            "id": 891,
            "url": "http://www.brekke.com/aut-nisi-ut-laboriosam-illum-alias-exercitationem",
            "original_url": "http://berge.com/doloribus-et-minus-deleniti-esse-non-iste-odit",
            "mtpc_url": "https://c.mtpc.se/891",
            "user_id": 3982,
            "country": "VN",
            "provider": "gray",
            "advertiser": {
                "id": 2297,
                "name": "Powlowski-Leuschke"
            },
            "title": "Prof. Edyth Wolf I",
            "created_at": "2026-04-21T11:54:02+02:00"
        },
        "author_id": 3983,
        "display_for_all_advertisers": false,
        "status": "active",
        "styles": null,
        "image": null,
        "starts_at": "2026-03-21T10:54:02.391674Z",
        "ends_at": "2026-05-21T09:54:02.391748Z",
        "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

required

Shared budget title

amount

integer

required

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

amount_v2

string[]

required

Amount of the shared budget, expressed with the money object.

consumed_budget

integer

required

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

consumed_budget_v2

string[]

required

The amount of budget that has been consumed or spent from the shared budget, expressed with the money object.

currency

string

required

Shared budget currency is the same as advertiser

campaigns_count

integer

required

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).
consumed_budget_v2 - object The current amount of money used by the campaign, expressed with the money object.
status - string Current status of the campaign (e.g., active, ended).
budget_limit - int Budget limit for the campaign, if applicable.
budget_limit_v2 - object Budget limit for the campaign, if applicable, expressed with the money object.
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/10/shared-budgets" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[
    {
        "id": null,
        "title": "Orie Kovacek",
        "amount": 4,
        "amount_v2": {
            "amount": "0.04",
            "currency": "PLN"
        },
        "consumed_budget": 0,
        "consumed_budget_v2": {
            "amount": "0",
            "currency": "PLN"
        },
        "currency": "PLN"
    },
    {
        "id": null,
        "title": "Dr. Teresa Beier DVM",
        "amount": 4,
        "amount_v2": {
            "amount": "0.04",
            "currency": "EUR"
        },
        "consumed_budget": 0,
        "consumed_budget_v2": {
            "amount": "0",
            "currency": "EUR"
        },
        "currency": "EUR"
    }
]

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

required

Shared budget title

amount

integer

required

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

amount_v2

string[]

required

Amount of the shared budget, expressed with the money object.

consumed_budget

integer

required

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

consumed_budget_v2

string[]

required

The amount of budget that has been consumed or spent from the shared budget, expressed with the money object.

currency

string

required

Shared budget currency is the same as advertiser

campaigns_count

integer

required

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).
consumed_budget_v2 - object The current amount of money used by the campaign, expressed with the money object.
status - string Current status of the campaign (e.g., active, ended).
budget_limit - int Budget limit for the campaign, if applicable.
budget_limit_v2 - object Budget limit for the campaign, if applicable, expressed with the money object.
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/12/shared-budgets/14" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "id": null,
    "title": "Mrs. Kaycee Sipes",
    "amount": 8,
    "amount_v2": {
        "amount": "0.08",
        "currency": "SEK"
    },
    "consumed_budget": 0,
    "consumed_budget_v2": {
        "amount": "0",
        "currency": "SEK"
    },
    "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

required

Shared budget title

amount

integer

required

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

amount_v2

string[]

required

Amount of the shared budget, expressed with the money object.

consumed_budget

integer

required

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

consumed_budget_v2

string[]

required

The amount of budget that has been consumed or spent from the shared budget, expressed with the money object.

currency

string

required

Shared budget currency is the same as advertiser

campaigns_count

integer

required

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).
consumed_budget_v2 - object The current amount of money used by the campaign, expressed with the money object.
status - string Current status of the campaign (e.g., active, ended).
budget_limit - int Budget limit for the campaign, if applicable.
budget_limit_v2 - object Budget limit for the campaign, if applicable, expressed with the money object.
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/14/shared-budgets/16" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Summer budget\",
    \"amount\": 10000
}"

Example response:

{
    "id": null,
    "title": "Prof. Lavern Bechtelar PhD",
    "amount": 9,
    "amount_v2": {
        "amount": "0.09",
        "currency": "EUR"
    },
    "consumed_budget": 0,
    "consumed_budget_v2": {
        "amount": "0",
        "currency": "EUR"
    },
    "currency": "EUR"
}

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/6" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Store

PUT v2/stores/{advertiser}/payment

PUT

POST

https://api.metapic.dev

/v2/stores/{advertiser}/payment

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

advertiser

integer

required

Example:

Body Parameters

payment_setup_id

string

required

Example:

delectus

Auth

Headers

URL Parameters

Body

{ "payment_setup_id": "delectus" }

Received response

Example request:

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

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: 50MB kb. Allowed types: image/*.

Example:

eius

Response Fields

url

string

required

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

base64

string

required

Image key (base64 encoded image path)

key

string

required

Image key (base64 encoded image path)

base_url

string

required

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

Auth

Headers

Body

{ "image": "eius" }

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

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:

advertiser_id

integer

required

Filter users by advertiser/store id. Required for non-admin advertiser users. Admins can pass it optionally. The id of an existing record in the stores table.

Example:

123

include

string[]

Must be one of:

email

Example:

["email"]

size

integer

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

Example:

sort_by

string

Example:

beatae

status

string

User status (accepted, suspended, undecided). When omitted, suspended users are excluded.

Must be one of:

accepted
suspended
undecided

Example:

accepted

Response Fields

integer

required

The ID of the user

username

string

required

The username of the user

display_name

string

required

The display name of the user (first and last name)

string

The email of the user

client_id

string

required

The client ID associated with the user

preferred_locale

string

required

The preferred locale of the user

language

string

required

The preferred language of the user

currency

string

The currency associated with the user's advertiser group

advertiser_group_id

integer

The advertiser group ID associated with the user's advertiser group

image

object

The profile image of the user, if available

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&advertiser_id=123&include[]=email&size=20&sort_by=beatae&status=accepted" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": 14,
            "username": "tod.huel",
            "display_name": "Maude Wolff",
            "email": "[email protected]",
            "client_id": 16,
            "preferred_locale": "oc_FR",
            "language": "oc"
        },
        {
            "id": 14,
            "username": "tod.huel",
            "display_name": "Maude Wolff",
            "email": "[email protected]",
            "client_id": 16,
            "preferred_locale": "oc_FR",
            "language": "oc"
        }
    ],
    "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",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Get User Details

GET

https://api.metapic.dev

/v2/users/{id}

requires authentication

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the user.

Example:

Response Fields

integer

required

The ID of the user

username

string

required

The username of the user

display_name

string

required

The display name of the user (first and last name)

string

The email of the user

client_id

string

required

The client ID associated with the user

preferred_locale

string

required

The preferred locale of the user

language

string

required

The preferred language of the user

currency

string

The currency associated with the user's advertiser group

advertiser_group_id

integer

The advertiser group ID associated with the user's advertiser group

image

object

The profile image of the user, if available

Auth

Headers

URL Parameters

Received response

Example request:

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

Example response:

{
    "id": 14,
    "username": "tod.huel",
    "display_name": "Maude Wolff",
    "email": "[email protected]",
    "client_id": 16,
    "preferred_locale": "oc_FR",
    "language": "oc"
}

Create Creator User

POST

https://api.metapic.dev

/v2/users

requires authentication

Requires an Ory-issued JWT for a session not yet linked to a Metapic user (no user_id).

Headers

Authorization

Example:

Bearer {JWT}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

social_media

object[]

required

List of connected social media accounts.

utm

object

Optional UTM tracking parameters.

Example:

{"source":"instagram","medium":"social","campaign":"launch2025","term":"influencer","content":"story_ad"}

client_id

string

required

The client ID associated with the registration (must exist in clients table). The client_id of an existing record in the clients table.

Example:

client_12345

preferred_locale

string

The locale code preference of the user (e.g., en-GB).

Example:

en-GB

Response Fields

integer

required

The ID of the user

username

string

required

The username of the user

display_name

string

required

The display name of the user (first and last name)

string

The email of the user

client_id

string

required

The client ID associated with the user

preferred_locale

string

required

The preferred locale of the user

language

string

required

The preferred language of the user

currency

string

The currency associated with the user's advertiser group

advertiser_group_id

integer

The advertiser group ID associated with the user's advertiser group

image

object

The profile image of the user, if available

Auth

Headers

Body

{ "social_media": [ { "type": "instagram", "identifier": "https:\/\/instagram.com\/example" } ], "utm": { "source": "instagram", "medium": "social", "campaign": "launch2025", "term": "influencer", "content": "story_ad" }, "client_id": "client_12345", "preferred_locale": "en-GB" }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/users" \
    --header "Authorization: Bearer {JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"social_media\": [
        {
            \"type\": \"instagram\",
            \"identifier\": \"https:\\/\\/instagram.com\\/example\"
        },
        {
            \"type\": \"tiktok\",
            \"identifier\": \"https:\\/\\/tiktok.com\\/@example\"
        }
    ],
    \"utm\": {
        \"source\": \"instagram\",
        \"medium\": \"social\",
        \"campaign\": \"launch2025\",
        \"term\": \"influencer\",
        \"content\": \"story_ad\"
    },
    \"client_id\": \"client_12345\",
    \"preferred_locale\": \"en-GB\"
}"

Example response:

{
    "id": 14,
    "username": "tod.huel",
    "display_name": "Maude Wolff",
    "email": "[email protected]",
    "client_id": 16,
    "preferred_locale": "oc_FR",
    "language": "oc"
}

Update User Identity

PUT

https://api.metapic.dev

/v2/users/{user_id}/identity

requires authentication

It updates user's email and phone and syncs it with Ory identity.

Headers

Authorization

Example:

Bearer {JWT}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

string

required

The email address of the user. The value format is invalid. Must not be greater than 254 characters.

Example:

[email protected]

phone

string

The phone number of the user.

Example:

+1234567890

Auth

Headers

URL Parameters

Body

{ "email": "[email protected]", "phone": "+1234567890" }

Received response

Example request:

curl --request PUT \
    "https://api.metapic.dev/v2/users/14/identity" \
    --header "Authorization: Bearer {JWT}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"phone\": \"+1234567890\"
}"

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[]

required

The result of matched users

unmatched_users

string[]

required

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"

Approve users

POST

https://api.metapic.dev

/v2/approve-users

requires authentication

Approves multiple users at once. When approving a banned user, it cleans up the banned_at (suspended_at) property and sets the approved_at (verified_at). Events are triggered only for users whose status actually changes.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_ids

integer[]

required

Example:

[4]

Response Fields

approved

integer

required

The number of users that were approved

Auth

Headers

Body

{ "user_ids": [ 4 ] }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/approve-users" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_ids\": [
        4
    ]
}"

Ban users

POST

https://api.metapic.dev

/v2/ban-users

requires authentication

Bans multiple users at once. The ban action also deletes all user offers. Events are triggered only for users whose status actually changes.

Headers

Authorization

Example:

{accessToken}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_ids

integer[]

required

Example:

[13]

Response Fields

banned

integer

required

The number of users that were banned

Auth

Headers

Body

{ "user_ids": [ 13 ] }

Received response

Example request:

curl --request POST \
    "https://api.metapic.dev/v2/ban-users" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_ids\": [
        13
    ]
}"

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:

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=et" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": [
        {
            "id": null,
            "name": "Jaclyn Goodwin",
            "slug": "maiores-sapiente",
            "access_level": 1,
            "store_id": 2300
        },
        {
            "id": null,
            "name": "Mrs. Dorris Swaniawski",
            "slug": "ipsum-repudiandae-qui",
            "access_level": 1,
            "store_id": 2301
        }
    ],
    "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",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}