Introduction

This documentation aims to provide all the information you need to work with our API. The v2 (and above) API follows the Design Principles and Guidelines. If you find anything that doesn't comply, please complain to the dev team immediately 👮

Authenticating requests

To authenticate requests, include a Authorization header with the value "{accessToken}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

For more information see Authentication in the P&E docs.

Advertiser Groups

List advertiser groups

GET
https://api.metapic.dev
/v2/advertiser-groups
requires authentication

Endpoint for querying & sorting all advertiser groups.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

return_ad_enabled
boolean

Only return advertiser groups which have return ads enabled.

size
integer

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

Example:
20
sort_by
string

Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Example:
created_at:desc
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/advertiser-groups?return_ad_enabled=&size=20&sort_by=created_at%3Adesc" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "name": "Olson and Sons",
            "key": "ar_OM",
            "currency": "SEK"
        },
        {
            "id": null,
            "name": "Moen-Langworth",
            "key": "so_ET",
            "currency": "USD"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

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
Accept
Example:
application/json

Query Parameters

name
string

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

Example:
Metapic SE
store_group_id
integer

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

Example:
15
size
integer

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

Example:
20
sort_by
string

Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Example:
created_at:desc
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/clients?name=Metapic+SE&store_group_id=15&size=20&sort_by=created_at%3Adesc" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "name": "Abigale Herzog"
        },
        {
            "id": null,
            "name": "Janis Sporer"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

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
Accept
Example:
application/json

Query Parameters

query
string

Filters media by username.

Example:
consequuntur
status
string

Filter user media by show store value.

Must be one of:
  • all
  • 0
  • 1
  • 2
Example:
2
type
string

Filters media by type.

Must be one of:
  • all
  • instagram
  • tiktok
  • youtube
Example:
instagram
favorite
string

Filter user media by favorite value.

Must be one of:
  • all
  • 1
  • 0
Example:
1
group
integer

:shrug:.

Example:
13
format
string

Format to export.

Must be one of:
  • csv
  • xlsx
  • json
Example:
csv

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/user-media?query=consequuntur&status=2&type=instagram&favorite=1&group=13&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": "« Previous",
            "active": false
        },
        {
            "url": "http://metapic-api.my/user-media?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": "http://metapic-api.my/user-media?page=2",
            "label": "2",
            "active": false
        },
        {
            "url": "http://metapic-api.my/user-media?page=3",
            "label": "3",
            "active": false
        },
        {
            "url": "http://metapic-api.my/user-media?page=2",
            "label": "Next »",
            "active": false
        }
    ],
    "next_page_url": "http://metapic-api.my/user-media?page=2",
    "path": "http://metapic-api.my/user-media",
    "per_page": 5,
    "prev_page_url": null,
    "to": 5,
    "total": 12
}

Endpoints

Get Store Categories

GET
https://api.metapic.dev
/v2/store-categories
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/store-categories" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[
    {
        "id": null,
        "name": "Food"
    },
    {
        "id": null,
        "name": "Beauty"
    }
]

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

GET
https://api.metapic.dev
/v2/users/{user_id}/stores-by-categories
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
4
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/users/4/stores-by-categories" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

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

GET
https://api.metapic.dev
/v2/users/{user_id}/stores-by-toplist
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
13
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/users/13/stores-by-toplist" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Entrypoint

App's entrypoint

GET
https://api.metapic.dev
/v2/entrypoint
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Response Fields

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\": 6
}"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Offer

Create campaign

POST
https://api.metapic.dev
/v2/stores/{store_id}/offers
requires authentication

Creates new campaign for a store.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The store ID.

Example:
15

Body Parameters

Response Fields

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\": 9,
    \"type\": \"suggestion\",
    \"name\": \"Summer campaign for VIP creators\",
    \"campaign_title\": \"Summer campaign\",
    \"campaign_text\": \"This is a summer campaign!\",
    \"has_product_seeding\": false,
    \"has_onetime_payment\": false,
    \"per_user_limit\": false,
    \"one_time_payment\": 6369524.2359,
    \"budget_limit\": 6,
    \"max_clicks\": 18,
    \"valid_from\": \"2025-01-15T16:22:01\",
    \"valid_until\": \"2084-09-07\",
    \"todo\": [
        \"nzhhnvbenlymqeccxbd\"
    ],
    \"store_visibility\": \"2\",
    \"show_for_advertiser\": true,
    \"priority_after\": 2,
    \"shared_budget_id\": 1,
    \"shared_budget\": {
        \"title\": \"Summer budget\",
        \"amount\": 10000
    },
    \"targets\": {
        \"user_ids\": [
            19
        ],
        \"user_tag_ids\": [
            10
        ],
        \"store_group_ids\": [
            17
        ],
        \"emails\": [
            \"[email protected]\"
        ],
        \"social_media_identifiers\": [
            \"vtxfhhnipwveclnlhavdx\"
        ],
        \"client_ids\": [
            5
        ],
        \"revenue_tier_ids\": [
            8
        ]
    },
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": 230,
            \"cpa\": 0.2,
            \"invoice_cpc\": 250,
            \"invoice_cpa\": 0.25,
            \"user_revenue\": 1
        }
    ]
}"
Example response:
{
    "data": {
        "id": null,
        "campaign_title": "Zoe Keebler",
        "campaign_text": "Est est quisquam enim consequatur. Earum repellendus et ad molestiae. Enim ducimus vitae ipsum illo voluptas cum vel.",
        "has_product_seeding": null,
        "has_onetime_payment": null,
        "status": "active",
        "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA4ODY2P3RleHQ9ZXN0",
        "image": null,
        "store_id": 1611,
        "token": null,
        "type": "standard",
        "warnings": {
            "skipped_targets": {
                "user_ids": [
                    12,
                    15
                ]
            }
        }
    },
    "warnings": {
        "skipped_targets": {
            "user_ids": [
                12,
                15
            ]
        }
    }
}

Display campaign

GET
https://api.metapic.dev
/v2/offers/{offer_id}
requires authentication

Returns information about a specific campaign.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Response Fields

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": "Jacinthe Nienow",
    "campaign_text": "Quibusdam doloribus molestiae voluptas minima aut. Velit itaque quibusdam aliquam omnis. Ut exercitationem et consectetur ea ab ipsam.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBiYjc3P3RleHQ9c2VxdWk=",
    "image": null,
    "store_id": 1612,
    "token": null,
    "type": "standard"
}

Update campaign

PUT
PATCH
https://api.metapic.dev
/v2/offers/{id}
requires authentication

Updates existing campaign.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the offer.

Example:
7
offer_id
integer
required

The offer ID

Example:
15556

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.metapic.dev/v2/offers/7" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"store_group_id\": 1,
    \"type\": \"user_accept\",
    \"name\": \"Summer campaign for VIP creators\",
    \"campaign_title\": \"Summer campaign\",
    \"campaign_text\": \"This is a summer campaign!\",
    \"has_product_seeding\": true,
    \"has_onetime_payment\": true,
    \"per_user_limit\": false,
    \"one_time_payment\": 3215.939,
    \"budget_limit\": 19,
    \"max_clicks\": 1,
    \"valid_from\": \"2025-01-15T16:22:01\",
    \"valid_until\": \"2093-03-27\",
    \"todo\": [
        \"ukhywxagnr\"
    ],
    \"store_visibility\": \"2\",
    \"show_for_advertiser\": true,
    \"priority_after\": 1,
    \"traffic_sources_costs\": [
        {
            \"source\": 1,
            \"cpc\": 230,
            \"cpa\": 0.2,
            \"invoice_cpc\": 250,
            \"invoice_cpa\": 0.25,
            \"user_revenue\": 1
        }
    ],
    \"targets\": {
        \"0\": [],
        \"user_ids\": [
            14
        ],
        \"user_tag_ids\": [
            17
        ],
        \"store_group_ids\": [
            15
        ],
        \"emails\": [
            \"[email protected]\"
        ],
        \"social_media_identifiers\": [
            \"amhjjkkzsazbbcbpefnsxi\"
        ],
        \"client_ids\": [
            15
        ],
        \"revenue_tier_ids\": [
            17
        ]
    },
    \"shared_budget_id\": 1,
    \"shared_budget\": {
        \"title\": \"Summer budget\",
        \"amount\": 10000
    }
}"
Example response:
{
    "data": {
        "id": null,
        "campaign_title": "Lelah Sipes",
        "campaign_text": "Rerum iusto natus culpa similique dolorum adipisci aut. Aperiam nihil quidem in nobis. Quos commodi quas rerum possimus ut dolore.",
        "has_product_seeding": null,
        "has_onetime_payment": null,
        "status": "active",
        "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjYzQ0P3RleHQ9ZG9sb3JpYnVz",
        "image": null,
        "store_id": 1613,
        "token": null,
        "type": "standard",
        "warnings": {
            "skipped_targets": {
                "user_ids": [
                    12,
                    15
                ]
            }
        }
    },
    "warnings": {
        "skipped_targets": {
            "user_ids": [
                12,
                15
            ]
        }
    }
}

Delete campaign

DELETE
https://api.metapic.dev
/v2/offers/{id}
requires authentication

Soft deletes a campaign.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the offer.

Example:
14
offer_id
integer
required

The offer ID

Example:
15556
Example request:
curl --request DELETE \
    "https://api.metapic.dev/v2/offers/14" \
    --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
Accept
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:
["paused"]
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:
4
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:
14
size
integer

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

Example:
20
sort_by
string

Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Example:
created_at:desc
custom_sort_by
string
Must be one of:
  • ends_soon
Example:
ends_soon
include
string[]

Include optional relationships in the response.

Must be one of:
  • trafficSourcesCosts
  • store
  • targets
  • sharedBudget
Example:
["sharedBudget"]
format
string
Must be one of:
  • csv
  • xlsx
Example:
xlsx

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers?query=black+friday&statuses[]=paused&store_ids[]=1&store_group_ids[]=1&created_by=4&or_id=1234&target_user_id=14&size=20&sort_by=created_at%3Adesc&custom_sort_by=ends_soon&include[]=sharedBudget&format=xlsx" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "campaign_title": "Danielle Doyle",
            "campaign_text": "Harum laudantium aut sapiente est. Sapiente saepe consequatur quae assumenda quo a vel. Repudiandae consequatur ea odio quia eum. Pariatur quaerat mollitia corporis amet illum culpa.",
            "has_product_seeding": null,
            "has_onetime_payment": null,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZDU1P3RleHQ9Y3VwaWRpdGF0ZQ==",
            "image": null,
            "store_id": 1614,
            "token": null,
            "type": "standard"
        },
        {
            "id": null,
            "campaign_title": "Angelo Jakubowski",
            "campaign_text": "Est modi sit vero amet ea ex. Rerum asperiores aut et dolor consequatur dolorem. Velit velit velit quae eaque. Non non cumque aspernatur hic.",
            "has_product_seeding": null,
            "has_onetime_payment": null,
            "status": "active",
            "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBhYWZmP3RleHQ9c2ludA==",
            "image": null,
            "store_id": 1615,
            "token": null,
            "type": "standard"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "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
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Body Parameters

Response Fields

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\": \"consequuntur\"
}"
Example response:
{
    "id": null,
    "campaign_title": "Orin Blanda",
    "campaign_text": "Ut aspernatur eius ut totam beatae nostrum. Tempore et ad voluptatum optio voluptatem. Aut incidunt consequatur ad sit.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAzMzk5P3RleHQ9ZG9sb3JlbQ==",
    "image": null,
    "store_id": 1616,
    "token": null,
    "type": "standard"
}

Pause campaign

PUT
https://api.metapic.dev
/v2/offers/{offer_id}/pause
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Response Fields

Example request:
curl --request PUT \
    "https://api.metapic.dev/v2/offers/15556/pause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "campaign_title": "Sage Zulauf I",
    "campaign_text": "Quisquam nesciunt ea pariatur vel aut aut asperiores. Veritatis tenetur placeat ducimus facere pariatur. Maiores maiores architecto perspiciatis ut earum quo.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBmZjQ0P3RleHQ9ZGVsZW5pdGk=",
    "image": null,
    "store_id": 1617,
    "token": null,
    "type": "standard"
}

Unpause campaign

PUT
https://api.metapic.dev
/v2/offers/{offer_id}/unpause
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Response Fields

Example request:
curl --request PUT \
    "https://api.metapic.dev/v2/offers/15556/unpause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "campaign_title": "Sarah Upton MD",
    "campaign_text": "Fugiat explicabo aut itaque sit omnis. Cupiditate reprehenderit officiis sunt. Omnis ullam aliquam maxime minus temporibus. Sunt quibusdam doloremque autem vitae quisquam.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDA3NzExP3RleHQ9dG90YW0=",
    "image": null,
    "store_id": 1618,
    "token": null,
    "type": "standard"
}
null

Pause campaign

POST
https://api.metapic.dev
/v2/offers/{offer_id}/pause
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Response Fields

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": "Omari Dickens",
    "campaign_text": "Est delectus qui dolorum cum. Aut in aut quisquam reiciendis et sequi voluptatem. Impedit et cum dolore architecto amet sit aut ut.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBkZGNjP3RleHQ9ZXQ=",
    "image": null,
    "store_id": 1619,
    "token": null,
    "type": "standard"
}

Unpause campaign

POST
https://api.metapic.dev
/v2/offers/{offer_id}/unpause
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Response Fields

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": "Tony Gutmann IV",
    "campaign_text": "Maxime similique et debitis qui. Excepturi cupiditate optio facilis in consectetur id autem. Ex id assumenda quae minus eius deserunt.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDBjY2VlP3RleHQ9c2Vk",
    "image": null,
    "store_id": 1620,
    "token": null,
    "type": "standard"
}
null

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
Accept
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

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\": \"2023-07-29\",
    \"end_date\": \"2030-06-15\"
}"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

GET v2/users/{user_id}/offers

GET
https://api.metapic.dev
/v2/users/{user_id}/offers
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

user_id
integer
required

The ID of the user.

Example:
11

Body Parameters

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/users/11/offers" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"accepted\",
    \"name\": \"qjpieuggrnszit\"
}"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Display campaign

GET
https://api.metapic.dev
/v2/offer-by-token/{offer_token}
requires authentication

Returns information about a specific campaign.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_token
string
required
Example:
expedita
offer_id
integer
required

The offer ID

Example:
15556

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offer-by-token/expedita" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "campaign_title": "Vance Leffler",
    "campaign_text": "Veniam molestias esse ipsa voluptas rem ea. Odio velit facere reprehenderit tenetur. Quaerat reprehenderit est molestiae autem. Minima alias et laudantium enim consequatur dolor.",
    "has_product_seeding": null,
    "has_onetime_payment": null,
    "status": "active",
    "image_url": "https://media.metapic.com/insecure/rs:fill:800:500/g:sm/dXBsb2Fkcy9odHRwczovL3ZpYS5wbGFjZWhvbGRlci5jb20vNjQweDQ4MC5wbmcvMDAwMDQ0P3RleHQ9dG90YW0=",
    "image": null,
    "store_id": 1644,
    "token": null,
    "type": "standard"
}

Offer Target


Get targets for offer

GET
https://api.metapic.dev
/v2/offers/{offer_id}/targets
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers/15556/targets" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Add new targets to offer

POST
https://api.metapic.dev
/v2/offers/{offer_id}/targets
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The offer ID

Example:
15556

Body Parameters

Response Fields

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\": [
        16
    ],
    \"user_tag_ids\": [
        6
    ],
    \"store_group_ids\": [
        6
    ],
    \"emails\": [
        \"[email protected]\"
    ],
    \"social_media_identifiers\": [
        \"xauflwyfxuqt\"
    ],
    \"client_ids\": [
        14
    ],
    \"revenue_tier_ids\": [
        19
    ]
}"

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
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The ID of the offer.

Example:
1
id
integer
required

The ID of the user.

Example:
19
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers/1/users/19" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

List participants in a campaign

GET
https://api.metapic.dev
/v2/offers/{offer_id}/participants
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The ID of the offer.

Example:
14

Body Parameters

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers/14/participants" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"askaedzhgaimbmpryhwn\",
    \"status\": \"denied\"
}"
Example response:
{
    "data": [
        {
            "id": null,
            "offer_id": 597,
            "user_id": null,
            "display_name": "[email protected]",
            "clicks": 2,
            "status": "product_sent",
            "pre_registered_email": "[email protected]",
            "todo": null,
            "payment_amount": null,
            "offer_comments_count": 12
        },
        {
            "id": null,
            "offer_id": 598,
            "user_id": null,
            "display_name": "ondricka.rosalee",
            "clicks": 92,
            "status": "have_posted",
            "pre_registered_identifier": "ondricka.rosalee",
            "todo": null,
            "payment_amount": null,
            "offer_comments_count": 92
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The ID of the offer.

Example:
19
id
integer
required

The ID of the participant.

Example:
13

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers/19/participants/13" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "offer_id": 599,
    "user_id": 2671,
    "display_name": "[email protected]",
    "clicks": 0,
    "status": "applied",
    "pre_registered_email": "[email protected]",
    "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
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The ID of the offer.

Example:
7

Body Parameters

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers/7/participants-stats" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"ffkcpddjjjmcindssh\",
    \"active\": true,
    \"start_date\": \"1997-12-31\",
    \"end_date\": \"2073-11-30\",
    \"sort_by\": \"links_created:desc\"
}"
Example response:
{
    "data": [
        {
            "id": null,
            "user_id": 2672,
            "display_name": "elta88",
            "clicks": 8594,
            "status": "store_denied",
            "username": "elta88",
            "links_created": null,
            "estimated_gp": null,
            "estimated_earning_to_cost_ratio": null
        },
        {
            "id": null,
            "user_id": null,
            "display_name": "[email protected]",
            "clicks": 7091,
            "status": "done",
            "username": null,
            "links_created": null,
            "estimated_gp": null,
            "estimated_earning_to_cost_ratio": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 10,
        "to": 2,
        "total": 2
    }
}

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
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The ID of the offer.

Example:
14

Body Parameters

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offers/14/participants-count-by-click-activity" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2022-07-23\",
    \"end_date\": \"2121-03-06\"
}"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Update participant status

PATCH
https://api.metapic.dev
/v2/offers/{offer_id}/participants/{participant_id}/update-status
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_id
integer
required

The ID of the offer.

Example:
13
participant_id
integer
required

The ID of the participant.

Example:
2

Body Parameters

Response Fields

Example request:
curl --request PATCH \
    "https://api.metapic.dev/v2/offers/13/participants/2/update-status" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"applied\"
}"
Example response:
{
    "id": null,
    "offer_id": 602,
    "user_id": 2675,
    "display_name": "ortiz.rebekah",
    "clicks": 841494,
    "status": "applied",
    "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/{userId}
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_token
string
required
Example:
voluptatem
userId
integer
required
Example:
9
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offer-by-token/voluptatem/users/9" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                                                                                    set-cookie
                                                            : metapic_session=eyJpdiI6IlR0QVpiblNHYXRENXJBcUVEdlNOekE9PSIsInZhbHVlIjoibWRXR0hUeXpHTTVaUlRJRmJjcXc1VEpqVFdPY25FeUdXSUpERjZtOFg4c1hNZ085ZTFUTkUyam4xZFN3KzcwUXRwZm8rMHUrbm1ITUhsaGlBRHFPQ0puZG1TOGtpc0c3Y2E1RFB5NG5FS1pZcnVhQW9kbmlhT1J4Mk9pK2l1MHAiLCJtYWMiOiI5NDk2OTQyOTI1NGY5MTJiMTM1NTk1NjY1MDM1MWY5MzQ4MWUxZTBkZTkzMjMyNzQxNjFhZTdkMWNkOTI5MjdhIiwidGFnIjoiIn0%3D; expires=Wed, 15 Jan 2025 17:22:02 GMT; Max-Age=7200; path=/; httponly
                                                         
{
    "message": "Unauthenticated."
}

Mark user as having joined the campaign

POST
https://api.metapic.dev
/v2/offer-by-token/{offer_token}/users/{user_id}/join
requires authentication

This can only be performed by the user themselves.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offer_token
string
required
Example:
voluptatibus
user_id
integer
required

The ID of the user.

Example:
17
Example request:
curl --request POST \
    "https://api.metapic.dev/v2/offer-by-token/voluptatibus/users/17/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
Accept
Example:
application/json

URL Parameters

offer_user_id
string
required

The ID of the offerUser.

Example:
1

Body Parameters

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

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
Accept
Example:
application/json

URL Parameters

offer_user_id
string
required

The ID of the offerUser.

Example:
1
id
integer
required

The ID of the comment.

Example:
8
offer_comment_id
string
required

The ID of the comment.

Example:
1

Body Parameters

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

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
Accept
Example:
application/json

URL Parameters

offer_user_id
string
required

The ID of the offerUser.

Example:
1
id
integer
required

The ID of the comment.

Example:
7
offerCommentId
string
required

The ID of the comment.

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

Activity


Get the list of activities on OfferUser card

GET
https://api.metapic.dev
/v2/offer-users/{offerUser}/activities
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

offerUser
integer
required
Example:
13

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/offer-users/13/activities" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 300
                                                                                                                    x-ratelimit-remaining
                                                            : 300
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "message": "Unauthenticated."
}

Return Ads

List Return Ads

GET
https://api.metapic.dev
/v2/return-ads
requires authentication

Paginated list of Return Ads

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

size
integer

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

Example:
20
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:
["active"]
created_by
integer
Must be one of:
or_id
integer

Query by return ad's ID. Performs an 'OR' search, compared to 'AND' search for other filters, so an return ad with given ID is always included in the results, if matched.

Example:
1234
sort_by
string

Query sorted by (name, created_at, starts_at, ends_at, current_clicks, current_views, order_count, order_value, earnings or click_through_rate). Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Must be one of:
  • name:asc
  • name:desc
  • created_at:asc
  • created_at:desc
  • starts_at:asc
  • starts_at:desc
  • ends_at:asc
  • ends_at:desc
  • current_clicks:asc
  • current_clicks:desc
  • current_views:asc
  • current_views:desc
  • order_count:asc
  • order_count:desc
  • order_value:asc
  • order_value:desc
  • earnings:asc
  • earnings:desc
  • click_through_rate:asc
  • click_through_rate:desc
Example:
current_clicks:asc

Response Fields

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[]=active&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": "Graham Labadie",
            "advertiser_group_id": 3369,
            "affiliate_link": {
                "id": 759,
                "url": "http://www.prosacco.info/occaecati-tempore-aliquam-corrupti-molestiae-quia",
                "original_url": "https://www.kemmer.com/ex-omnis-minus-dolor-facere",
                "mtpc_url": "https://c.mtpc.se/759",
                "user_id": 2677,
                "country": "CX",
                "provider": "lime",
                "advertiser": {
                    "id": 1632,
                    "name": "Corkery, Osinski and Prosacco"
                }
            },
            "author_id": 2678,
            "display_for_all_advertisers": false,
            "status": "active",
            "styles": null,
            "image": null,
            "starts_at": "2024-12-15T15:22:01.913148Z",
            "ends_at": "2025-02-15T15:22:01.913190Z",
            "stats": []
        },
        {
            "id": null,
            "name": "Ernest Auer DDS",
            "advertiser_group_id": 3372,
            "affiliate_link": {
                "id": 760,
                "url": "http://mcclure.com/adipisci-voluptas-aliquam-aut-eligendi-corporis-maxime-asperiores.html",
                "original_url": "http://www.kulas.com/explicabo-consequatur-dolor-et-tempora.html",
                "mtpc_url": "https://c.mtpc.se/760",
                "user_id": 2679,
                "country": "NU",
                "provider": "silver",
                "advertiser": {
                    "id": 1633,
                    "name": "Wyman, Jacobs and Kassulke"
                }
            },
            "author_id": 2680,
            "display_for_all_advertisers": false,
            "status": "active",
            "styles": null,
            "image": null,
            "starts_at": "2024-12-15T15:22:01.927585Z",
            "ends_at": "2025-02-15T15:22:01.927625Z",
            "stats": []
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Create Return Ad

POST
https://api.metapic.dev
/v2/return-ads
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Response Fields

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\": \"etlsirdeyluhh\",
    \"advertiser_group_id\": 14,
    \"return_link\": \"https:\\/\\/advertiser.com\",
    \"display_for_all_advertisers\": true,
    \"advertiser_ids\": [
        12
    ],
    \"advertiser_category_ids\": [
        6
    ],
    \"styles\": {
        \"color\": \"#ffffff\"
    },
    \"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
    \"starts_at\": \"2025-01-15T16:22:01\",
    \"ends_at\": \"2116-09-27\",
    \"click_limit\": 14,
    \"view_limit\": 10
}"
Example response:
{
    "id": null,
    "name": "Odessa Funk",
    "advertiser_group_id": 3375,
    "affiliate_link": {
        "id": 761,
        "url": "http://rohan.com/distinctio-rerum-sequi-nihil-id-nostrum-illum",
        "original_url": "http://prohaska.info/minima-possimus-in-impedit-cupiditate-quo-omnis-at",
        "mtpc_url": "https://c.mtpc.se/761",
        "user_id": 2681,
        "country": "CH",
        "provider": "fuchsia",
        "advertiser": {
            "id": 1634,
            "name": "Eichmann Group"
        }
    },
    "author_id": 2682,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-15T15:22:01.965454Z",
    "ends_at": "2025-02-15T15:22:01.965494Z",
    "stats": []
}

Get Return Ad

GET
https://api.metapic.dev
/v2/return-ads/{id}
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the return ad.

Example:
2

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/return-ads/2" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "name": "Ms. Ernestine Dickens",
    "advertiser_group_id": 3378,
    "affiliate_link": {
        "id": 762,
        "url": "http://www.schuppe.com/rerum-nostrum-quo-et-quidem-sit-suscipit-mollitia-cupiditate",
        "original_url": "http://dibbert.net/",
        "mtpc_url": "https://c.mtpc.se/762",
        "user_id": 2683,
        "country": "ME",
        "provider": "purple",
        "advertiser": {
            "id": 1635,
            "name": "Trantow, Kozey and Weissnat"
        }
    },
    "author_id": 2684,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-15T15:22:01.989539Z",
    "ends_at": "2025-02-15T15:22:01.989582Z",
    "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
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the return ad.

Example:
12

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.metapic.dev/v2/return-ads/12" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"fyzfgwehfqcrvlzrkwj\",
    \"return_link\": \"https:\\/\\/advertiser.com\",
    \"display_for_all_advertisers\": false,
    \"advertiser_ids\": [
        9
    ],
    \"advertiser_category_ids\": [
        2
    ],
    \"styles\": {
        \"color\": \"#ffffff\"
    },
    \"image_key\": \"dG1wL2ltYWdlLmpwZw==\",
    \"starts_at\": \"2025-01-15T16:22:02\",
    \"ends_at\": \"2030-11-26\",
    \"click_limit\": 4,
    \"view_limit\": 7
}"
Example response:
{
    "id": null,
    "name": "Francis Abshire",
    "advertiser_group_id": 3381,
    "affiliate_link": {
        "id": 763,
        "url": "http://raynor.com/dolore-ut-suscipit-culpa-repellendus-quis",
        "original_url": "http://dach.net/",
        "mtpc_url": "https://c.mtpc.se/763",
        "user_id": 2685,
        "country": "SK",
        "provider": "fuchsia",
        "advertiser": {
            "id": 1636,
            "name": "Gerlach, Senger and Stoltenberg"
        }
    },
    "author_id": 2686,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-15T15:22:02.018871Z",
    "ends_at": "2025-02-15T15:22:02.018912Z",
    "stats": []
}

Delete Return Ad

DELETE
https://api.metapic.dev
/v2/return-ads/{id}
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

The ID of the return ad.

Example:
14
Example request:
curl --request DELETE \
    "https://api.metapic.dev/v2/return-ads/14" \
    --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
Accept
Example:
application/json

URL Parameters

returnAd_id
integer
required

The ID of the returnAd.

Example:
2

Response Fields

Example request:
curl --request POST \
    "https://api.metapic.dev/v2/return-ads/2/pause" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "name": "Magnus Hirthe V",
    "advertiser_group_id": 3384,
    "affiliate_link": {
        "id": 764,
        "url": "https://lehner.org/numquam-suscipit-corporis-quod-repellendus-commodi.html",
        "original_url": "http://www.hartmann.com/iure-cumque-minus-quam-recusandae",
        "mtpc_url": "https://c.mtpc.se/764",
        "user_id": 2687,
        "country": "BB",
        "provider": "aqua",
        "advertiser": {
            "id": 1637,
            "name": "Hammes, Torphy and Kerluke"
        }
    },
    "author_id": 2688,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-15T15:22:02.055216Z",
    "ends_at": "2025-02-15T15:22:02.055262Z",
    "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
Accept
Example:
application/json

URL Parameters

returnAd_id
integer
required

The ID of the returnAd.

Example:
16

Response Fields

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": "Estevan Quitzon",
    "advertiser_group_id": 3387,
    "affiliate_link": {
        "id": 765,
        "url": "https://fahey.net/sed-sed-ab-ratione-mollitia-autem-distinctio.html",
        "original_url": "http://ratke.info/qui-est-eum-cum-sint",
        "mtpc_url": "https://c.mtpc.se/765",
        "user_id": 2689,
        "country": "BQ",
        "provider": "teal",
        "advertiser": {
            "id": 1638,
            "name": "Hilpert PLC"
        }
    },
    "author_id": 2690,
    "display_for_all_advertisers": false,
    "status": "active",
    "styles": null,
    "image": null,
    "starts_at": "2024-12-15T15:22:02.087931Z",
    "ends_at": "2025-02-15T15:22:02.087973Z",
    "stats": []
}
POST
https://api.metapic.dev
/v2/affiliate-link-preview
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Response Fields

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

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
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The ID of the store.

Example:
9

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/advertisers/9/return-ads" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[
    {
        "id": null,
        "name": "Eusebio Nitzsche",
        "advertiser_group_id": 3390,
        "affiliate_link": {
            "id": 766,
            "url": "https://www.hackett.info/suscipit-rerum-architecto-aperiam-non",
            "original_url": "http://stokes.com/",
            "mtpc_url": "https://c.mtpc.se/766",
            "user_id": 2691,
            "country": "JM",
            "provider": "navy",
            "advertiser": {
                "id": 1639,
                "name": "Feest Ltd"
            }
        },
        "author_id": 2692,
        "display_for_all_advertisers": false,
        "status": "active",
        "styles": null,
        "image": null,
        "starts_at": "2024-12-15T15:22:02.116480Z",
        "ends_at": "2025-02-15T15:22:02.116542Z",
        "stats": []
    },
    {
        "id": null,
        "name": "Winifred Crooks Jr.",
        "advertiser_group_id": 3393,
        "affiliate_link": {
            "id": 767,
            "url": "http://www.tillman.com/molestias-sed-provident-aperiam-magni-aut-ducimus-et",
            "original_url": "http://hamill.net/",
            "mtpc_url": "https://c.mtpc.se/767",
            "user_id": 2693,
            "country": "SS",
            "provider": "lime",
            "advertiser": {
                "id": 1640,
                "name": "Jaskolski-Wintheiser"
            }
        },
        "author_id": 2694,
        "display_for_all_advertisers": false,
        "status": "active",
        "styles": null,
        "image": null,
        "starts_at": "2024-12-15T15:22:02.132405Z",
        "ends_at": "2025-02-15T15:22:02.132446Z",
        "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
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The ID of the store.

Example:
4

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/stores/4/shared-budgets" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[
    {
        "id": null,
        "title": "Prof. Daren Adams",
        "amount": 3,
        "consumed_budget": 0,
        "currency": "EUR"
    },
    {
        "id": null,
        "title": "Evalyn Bruen",
        "amount": 6,
        "consumed_budget": 0,
        "currency": "SEK"
    }
]

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
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The ID of the store.

Example:
19
id
integer
required

The ID of the shared budget.

Example:
20

Response Fields

Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/stores/19/shared-budgets/20" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "id": null,
    "title": "Dr. Elinor Zboncak",
    "amount": 6,
    "consumed_budget": 0,
    "currency": "EUR"
}

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
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The ID of the store.

Example:
16
id
integer
required

The ID of the shared budget.

Example:
11

Body Parameters

Response Fields

Example request:
curl --request PUT \
    "https://api.metapic.dev/v2/stores/16/shared-budgets/11" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Summer budget\",
    \"amount\": 10000
}"
Example response:
{
    "id": null,
    "title": "Prof. Sheila McGlynn",
    "amount": 8,
    "consumed_budget": 0,
    "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
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The ID of the store.

Example:
8
id
integer
required

The ID of the shared budget.

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

Store

List stores

GET
https://api.metapic.dev
/v2/stores
requires authentication

Endpoint for querying & sorting all stores.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
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:
15
size
integer

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

Example:
20
sort_by
string

Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Example:
created_at:desc
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/stores?query=nike&store_group_id=15&size=20&sort_by=created_at%3Adesc" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "name": "Botsford, Marquardt and Russel"
        },
        {
            "id": null,
            "name": "Schamberger LLC"
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

Create new self-service store

POST
https://api.metapic.dev
/v2/stores
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request:
curl --request POST \
    "https://api.metapic.dev/v2/stores" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"My Store\",
    \"domains\": [
        [
            \"dev.test-test.com\"
        ]
    ],
    \"categories\": [
        10
    ],
    \"logo_url\": \"https:\\/\\/mayer.com\\/necessitatibus-qui-labore-hic-labore.html\",
    \"country\": \" Example: SE\",
    \"currency\": \"Example: EUR\",
    \"language\": \"sv\",
    \"billing\": {
        \"company_name\": \"dolorem\",
        \"street\": \"aut\",
        \"postal_code\": \"cupiditate\",
        \"city\": \"et\",
        \"vat_number\": \"qui\"
    }
}"
Example response:
{
    "id": null,
    "name": "Keebler and Sons"
}

PUT v2/stores/{store_id}/payment

PUT
https://api.metapic.dev
/v2/stores/{store_id}/payment
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

store_id
integer
required

The ID of the store.

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

Tag

GET
https://api.metapic.dev
/v2/affiliate-links/{id}
requires authentication

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the affiliate link.

Example:
vitae

Response Fields

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

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
Accept
Example:
application/json

Body Parameters

Response Fields

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

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
Accept
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:
2
store_group_id
integer

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

Example:
15
size
integer

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

Example:
20
sort_by
string

Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Example:
created_at:desc
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/users?query=testcreator123&client_id=2&store_group_id=15&size=20&sort_by=created_at%3Adesc" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "username": "amanda40",
            "email": "[email protected]",
            "client_id": 2718
        },
        {
            "id": null,
            "username": "frida70",
            "email": "[email protected]",
            "client_id": 2719
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}

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
Accept
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:
15
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

Example request:
curl --request POST \
    "https://api.metapic.dev/v2/match-users?advertiser_group_id=15&user_emails_or_ids[]=12345&user_emails_or_ids[]=email%40metapic.com" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

User Tag

List user tags

GET
https://api.metapic.dev
/v2/user-tags
requires authentication

Endpoint for querying & sorting all user tags.

Headers

Authorization
Example:
{accessToken}
Content-Type
Example:
application/json
Accept
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:
15
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:
  • 0
  • 1
  • 2
Example:
[0,1]
size
integer

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

Example:
20
sort_by
string

Must follow the correct format: column_name:direction, where column_name must be a valid property for given resource and direction can be one of asc|desc, both of which are required if sort_by is present.

Example:
created_at:desc
Example request:
curl --request GET \
    --get "https://api.metapic.dev/v2/user-tags?name=favourites&store_id=15&access_levels[]=0&access_levels[]=1&size=20&sort_by=created_at%3Adesc" \
    --header "Authorization: {accessToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
    "data": [
        {
            "id": null,
            "name": "Mrs. Dorothea Lynch MD",
            "slug": "earum-accusantium",
            "access_level": 1,
            "store_id": 1641
        },
        {
            "id": null,
            "name": "Cristal Volkman",
            "slug": "ut-accusantium-et",
            "access_level": 1,
            "store_id": 1642
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 20,
        "to": 2,
        "total": 2
    }
}