PayMongo HomeGuidesAPI ReferenceStart Building
API Reference

Deal Home metrics

get
https://sales-api.paymongo.com/v1/internal/deals/home_metrics
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
pipeline_id
array of strings

Comma-separated or repeated pipeline IDs

pipeline_id
stage_id
array of strings

Comma-separated or repeated stage IDs

stage_id
owner_ids
array of strings

Comma-separated or repeated owner IDs

owner_ids
string

Substring match on deal name or deal id (ILIKE, OR)

priority
array of strings

Comma-separated or repeated priorities

priority
business_group
array of strings

Comma-separated or repeated business groups

business_group
forecast_category
array of strings

Comma-separated or repeated forecast categories

forecast_category
deal_health_status
array of strings

Comma-separated or repeated deal health statuses

deal_health_status
boolean

Filter by linked org is_target_account

organization_icp_tier
array of strings

Comma-separated or repeated ICP tiers

organization_icp_tier
string

Created at lower bound (RFC3339)

string

Created at upper bound (RFC3339)

string

Expected close lower bound (RFC3339)

string

Expected close upper bound (RFC3339)

number

monthly_incremental_tpv lower bound, inclusive

number

monthly_incremental_tpv upper bound, inclusive

number

monthly_incremental_gp lower bound, inclusive

number

monthly_incremental_gp upper bound, inclusive

number

daily_incremental_gp lower bound, inclusive

number

daily_incremental_gp upper bound, inclusive

Responses

Updated 22 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago

Did this page help you?