Analytics & Reports

Use these live provider API operations for analytics.

GET /analytics

Fetch analytics data for a provider.

Inputs

Location	Field	Type	Required
query	timePeriod	string	Yes

Example

GET https://dispensaryapi.famasi.africa/api/v1/providers/analytics?timePeriod={value}

Returns 200 with these fields:

Field	Type
totalValue	number
averageValue	number
totalOrders	integer
percentageIncrease	string

Errors: 400 invalid time period, 500 server error.

GET /provider-orders/analytics

Fetch analytics data for provider orders.

Inputs

Location	Field	Type	Required
query	startDate	string	Yes
query	endDate	string	Yes
query	providerId	string	Yes
query	is_test	boolean	No

Example

GET https://dispensaryapi.famasi.africa/api/v1/providers/provider-orders/analytics?startDate={value}&endDate={value}&providerId={value}&is_test={value}

Returns 200 with these fields:

Field	Type
totalValue	number
averageValue	number
totalOrders	integer
percentageIncrease	string

Errors: 400 invalid query parameters, 500 server error.

GET /orders-stats

Fetch statistics for provider orders.

Inputs

Location	Field	Type	Required
query	start	string	No
query	end	string	No
query	query	string	No
query	page	integer	No

Example

GET https://dispensaryapi.famasi.africa/api/v1/providers/orders-stats?start={value}&end={value}&query={value}&page={value}

Returns 200 with these fields:

Field	Type
totalOrders	integer
totalOrderValue	number
totalCancelled	integer
totalCompleted	integer
totalPending	integer
averageOrderValue	number

Errors: 500 server error.

Authentication

Send a provider API key as x-api-key. Provider API keys →