Get business metrics and reports

GET /api/v1/businesses/metrics

Description

Retrieve business metrics and reports based on various parameters.

URL:

• Raw URL: /api/v1/businesses/metrics

• Host:

• Path: /api/v1/businesses/metrics

Query Parameters:

• metricDateRange: (Required) - Date range for the metrics, e.g., "2020-11-12,2022-11-15"

• byValueType: DAY (Required) - Type of value to group by

• byValue: - Value for grouping (required when "byValueType" is used)

• businessByKycStatus: APPROVE - Filter by KYC status

• businessByWalletAccount: - Filter by wallet account

• businessBySources: - Comma-separated list of sources (e.g., SHOP,TRACE,AGENCY,AGENT,DEAL,OWN,PLATFORM)

• businessByTypes: - Comma-separated list of business types (e.g., SUPPLIER,MERCHANT,AGENCY_BANKING,SABI_AGENT,SABI_OWN)

• businessByLocations: - Location filter (e.g., longitude,latitude or -40.943,29.2933)

• businessByTenantIds: - Filter by tenant IDs

• businessByUserIds: - Filter by user IDs

• businessByIds: - Filter by business IDs

• businessAddress: - Filter by business address

• businessSearch: - Search keyword

• businessByIsDistributor: 1 - Filter by distributor status

• businessByAcceptingOrder: 1 - Filter by accepting order status

• businessByActive: 1 - Filter by active status

Response:

• Status: OK (200)

/api/v1/businesses/metrics?metricDateRange=<string>&byValueType=DAY&byValue=<number>&businessByKycStatus=APPROVE&businessByWalletAccount=<string>&businessBySources=<string>&businessByTypes=<string>&businessByLocations=<string>&businessByTenantIds=<string>&businessByUserIds=<string>&businessByIds=<string>&businessAddress=<string>&businessSearch=<string>&businessByIsDistributor=1&businessByAcceptingOrder=1&businessByActive=1

Query Params

Param	value
metricDateRange	string
byValueType	DAY
byValue	number
businessByKycStatus	APPROVE
businessByWalletAccount	string
businessBySources	string
businessByTypes	string
businessByLocations	string
businessByTenantIds	string
businessByUserIds	string
businessByIds	string
businessAddress	string
businessSearch	string
businessByIsDistributor	1
businessByAcceptingOrder	1
businessByActive	1

🔑 Authentication bearer

Param	value	Type
token	bearerToken	string

Response: 200