MUmultigest
Dashboard Overview

Leads overview for dashboard

Changed on
get/api/dashboard/leads

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/dashboard/leads
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Query parameters

yearinteger nullable

Filter by year

monthinteger[]

Filter by month(s) within year

teams_idinteger[]

Filter by attribution funnel(s) — Z_Leads.teams_id, not owner membership

include_no_funnelboolean

Also match leads with no (or an orphaned) attribution funnel

sort_sellers_bystring nullable

Sort salespeople by: 'sales' (won count), 'value' (won value), 'profit' (vehicle margin). Default: total leads

idpointofsaleinteger[]

Point(s) of sale for the additive won_pv / total_won_value_pv fields (omit for none)

Headers

x-api-tokenstring nullable

Response

Successful Response

object required

Changes