Get List of Company Surge® Reports

This endpoint can be used to fetch the list of Company Surge® Reports made with the API.

Data Types

Response Object

Field name	Type	Description

Field name	Type	Description
Success	bool	Indicates whether a request was successful (true) or not (false)
Message	string	Error message if success is false
Page	int	Ignore - used internally. The entire list is returned in one response.
Records	int	Ignore - used internally. The entire list is returned in one response.
Total	int	Ignore - used internally. The entire list is returned in one response.

ProductList - Array of Company Surge® report objects

Field name	Type	Description

Field name	Type	Description
Autogen	string	The automatic report generation cadence for this report. Options are “Monthly”, “Weekly” or None. This field may not be present for non-autogen reports.
Companies	int	The number of unique company domains in the results of this report.
CreateDate	Datetime	Datetime that this report was created in EST (Eastern Standard Time) zone
Id		ID of this Company Surge® report
Name	string	Name of this Company Surge® report
Page	int	Ignore - used internally.
ReportDate	Datetime	Datetime that this report was last generated in EST (Eastern Standard Time) zone
Status	int	Current state of processing for this report. 1 is complete, 2 is processing.
Topics	int	Count of unique topics selected for this report

Request/Response

HTTP Request

GET https://sentry.bombora.com/v4/Surge/GetList

HTTP Request Header

Authorization: Basic {AUTH_KEY}
Referer: bombora.com

HTTP Response

If successful, the response contains all Company Surge® reports created within your account via the API.

{
'Message': None,
'Page': 0,
'ProductList': [
{
'Autogen': "Weekly",
'Companies': 21901,
'CreateDate': '2020-10-15T23:48:57.155-04:00',
'Id': 'eb5df4a5-c736-4eb4-8578-446271b5ee70',
'Name': 'Definition Example 1',
'Page': 0,
'ReportDate': None,
'Status': 2,
'Topics': 17
},
{
'Companies': 4638,
'CreateDate': '2020-10-15T23:48:58.883-04:00',
'Id': '35deef76-8678-41a4-b8d0-757ef4a0e135',
'Name': 'Definition Example 2',
'Page': 0,
'ReportDate': None,
'Status': 2,
'Topics': 6
}
],
'Records': 0,
'ResponseCode': 0,
'Success': True,
'Total': 0
}