Dashboards
Create a project dashboard
Requires dashboard.create. Creates a secondary dashboard with the given layout, or the default card set when layout is omitted.
A layout is { cards: [{ type, x, y, w, h, config? }] } on a 12-column grid: x + w <= 12, w and h at least the card minimum, each type at most once.
Only funnel takes config: { steps } with 1-12 unique ids, built-in (impressions, reach, ad_click, page_view, add_to_cart, start_checkout, purchase) or request event names; omitted means the built-in steps.
Sales cards are the ones prefixed "sales" below; use them for a conversion dashboard.
Cards:
- profit (min 3x5): sales: profit, revenue, expenses, ROAS and orders
- sales_chart (min 4x5): sales: revenue over time against the previous period
- achievement (min 3x5): sales: team all-time revenue milestone (getProjectDashboardAchievement)
- funnel (min 3x5): sales: conversion funnel from impressions to purchase; config.steps picks the steps
- payment_methods (min 3x4): sales: sales by payment method
- payment_status (min 3x3): sales: pending, approved, refunded and charged-back sales
- platform_share (min 3x2): sales: sales by sales platform
- traffic_source_share (min 3x3): sales: sales by traffic source
- geo (min 6x6): traffic: accesses on a world map (getProjectDashboardGeo)
- accesses_total (min 2x2): traffic: total accesses
- accesses_unique (min 2x2): traffic: unique accesses
- accesses_real (min 2x2): traffic: accesses without bots
- accesses_bots (min 2x2): traffic: bot accesses
- clients_device (min 3x5): audience: accesses by device
- clients_browser (min 3x5): audience: accesses by browser
- clients_os (min 3x5): audience: accesses by operating system
- clients_utm (min 3x5): audience: accesses by UTM source, medium, campaign, term and content
- clients_referrer (min 3x5): audience: accesses by referrer
- revenue_utm (min 3x5): sales: revenue by UTM source, medium, campaign, term and content
- top_pages (min 3x5): traffic: most accessed pages
- link_accesses (min 3x5): traffic: accesses by link and by domain
- time_distribution (min 4x5): sales: accesses, sales and revenue by hour of day and weekday
POST
Error