Merchant Marketing

Retrieves the marketing details of a logged in merchant.

Endpoint:

GET /company/merchants/{external_id}/marketing

Authorization: Bearer <ACCESS_TOKEN>

Response:

{
    "success": true,
    "data": [
        {
            "store_id": "store1",
            "integration": "META",
            "account_currency": "EGP",
            "account_id": "159753852369741",
            "account_name": "Shop_ads",
            "action_values":  [{ "action_type": "add_to_cart", "value": "250.25" }],
            "ad_id": "120216552253890334",
            "attribution_setting": "1d_click_1d_view",
            "auction_bid": "10.5",
            "auction_competitiveness": "0.8",
            "buying_type": "reach and frequency buying",
            "cpc": "24.12",
            "cpm": "8.4",
            "cpp": "4.2",
            "ctr": "0.2",
            "date_start": "2023-06-30",
            "date_stop": "2025-04-25",
            "full_view_impressions": "65",
            "full_view_reach": "24",
            "optimization_goal": "APP_INSTALLS",
            "purchase_roas": "250.5",
            "spend": "20.21"
        },
        {
            "store_id": "store1",
            "integration": "META",
            "account_currency": "EGP",
            "account_id": "159753852369741",
            "account_name": "shop_ads",
            "action_values": [{ "action_type": "purchase", "value": "199.99" }],
            "ad_id": "120216564304730334",
            "attribution_setting": "7d_click",
            "auction_bid": "12.4",
            "auction_competitiveness": "1.5",
            "buying_type": "fixed-price bidding",
            "cpc": "21.7",
            "cpm": "15.3",
            "cpp": "18.6",
            "ctr": "0.6",
            "date_start": "2023-06-30",
            "date_stop": "2025-04-25",
            "full_view_impressions": "512",
            "full_view_reach": "37",
            "optimization_goal": "LANDING_PAGE_VIEWS",
            "purchase_roas": "20.1",
            "spend": "18.7"
        }
    ]
}

Fields

`store_id`

The ID of the store.

`integration`

The integration type of the marketing.

`account_currency`

Currency that is used by your ad account.

`account_id`

The ad account ID number.

`account_name`

The ad account name.

`action_values`

The total value of all conversions attributed to your ads.

`ad_id`

The unique ID of the ad you're viewing in reporting.

`attribution_setting`

The default attribution window to be used when attribution result is calculated.

`auction_bid`

The amount your ad is willing to pay per outcome.

`auction_competitiveness`

A float representing how effective the ad is in comparison to advertisers targeting the same audience.

`buying_type`

The method by which you pay for and target ads in your campaigns. Possible values: ('dynamic auction bidding', 'fixed-price bidding','reach and frequency buying').

`cpc`

The average cost for each click.

`cpm`

The average cost for 1,000 impressions.

`cpp`

The average cost to reach 1,000 people. This metric is estimated.

`ctr`

The percentage of times people saw your ad and performed a click.

`date_start`

The start date for your data.

`date_stop`

The end date for your data.

`full_view_impressions`

The number of Full Views on your Page's posts as a result of your ad.

`full_view_reach`

The number of people who performed a full view on your Page's post as a result of your ad.

`optimization_goal`

The optimization goal you selected for your ad or ad set. Your optimization goal reflects what you want to optimize for the ads.

`purchase_roas`

The total return on ad spend (ROAS) from purchases.

`spend`

The estimated total amount of money you've spent on the ad during its schedule.