v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132917.8 KB
detailedLeadReports

Get detailed lead reports containing leads that have been received by all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.

get/v1/detailedLeadReports:search

Query parameters

endDate.dayinteger

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

endDate.monthinteger

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

endDate.yearinteger

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

pageSizeinteger

The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.

pageTokenstring

The next_page_token value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.

querystring

A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Detailed Lead Report for Manager with id | | | 123. | Required.

startDate.dayinteger

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

startDate.monthinteger

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

startDate.yearinteger

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Response

Successful response