Customer Activity Report

post

https://{dc-region}.zuperpro.com/api/reports/customer/activity

Generate a comprehensive customer activity report with detailed filtering options

Body Params

from_date

string

required

Start date (YYYY-MM-DD)

to_date

string

required

End date (YYYY-MM-DD)

date_type

string

Defaults to scheduled_date

skip_date_range

boolean

Defaults to false

include_uid

string

Specific customer UIDs to include (comma-separated)

filter_rules

string

Advanced filter rules JSON

filter.category

string

Customer categories (comma-separated)

filter.status

string

Customer status (active/inactive)

filter.organization

string

Organization UIDs (comma-separated)

filter.account_manager

string

Account manager UIDs (comma-separated)

filter.created_by

string

Creator user UIDs (comma-separated)

filter.created_at

string

Filter by creation date

filter.updated_at

string

Filter by update date

filter.email

string

Email addresses (comma-separated)

filter.phone

string

Phone numbers (comma-separated)

filter.city

string

Cities (comma-separated)

filter.state

string

States (comma-separated)

filter.zipcode

string

Zip codes (comma-separated)

filter.tags

string

Tags (comma-separated)

filter.company

string

Company names (comma-separated)

filter.ltv_min

number

Minimum lifetime value

filter.ltv_max

number

Maximum lifetime value

filter.credits_min

number

Minimum credits

filter.credits_max

number

Maximum credits

filter.receivables_min

number

Minimum receivables

filter.receivables_max

number

Maximum receivables

filter.job_count_min

number

Minimum job count

filter.job_count_max

number

Maximum job count

filter.notifications_sms

boolean

SMS notifications enabled

filter.notifications_call

boolean

Call notifications enabled

filter.notifications_email

boolean

Email notifications enabled

filter.portal_enabled

boolean

Customer portal enabled

filter.available_to_all

boolean

Available to all users

Responses

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Customer Activity report generated successfully

400Bad request - Invalid parameters

401Unauthorized - Missing or invalid authentication