...
| Field name | Type | Description | Default | Notes | |||||
|---|---|---|---|---|---|---|---|---|---|
| Domains | string[] | List of domains | N/A | Optional. At least one (1) domain is required. Cannot include both Domains and UploadedFile in a single request. | |||||
| UploadedFile | string | The file name that was returned from the UploadSurgeFile endpoint | N/A | Optional. File name must be exactly equal to the name that was returned. Cannot include both Domains and UploadedFile in a single request. For information about how to upload a file, see the Upload Your Database File for a Company Surge® Report documentation. | |||||
| Topics | int[] | List of topic IDs | None | Required. Maximum number of topics allowed depends on your permissions. | |||||
| TopicClusters | topicCluster[] | List of topic clusters | None | Optional. May use TopicClusters to replace Topics. May not use both Topics and TopicClusters.
| |||||
| ScoreThreshold | int | Value from 0-100 | 60 | Optional. If specified, only results with topic Company Surge® score equal to or above the specified number are returned. | |||||
| TopicThreshold | int | Value >= 1 | 1 | Optional. If specified, only domains showing an increase in interest on X amount of topics are returned. | |||||
| Name | string | Name of the Surge Report | Report's Id | Optional. If specified, will change the name of the report. | |||||
| Filters | filter[] | List of Filter Objects | None | Optional. A list of filter objects that will be used to filter Company Surge® data. e.g
| |||||
| GeographicScoreThreshold | int | value from 0-100 | 0 | Optional. If there are geographic filters present, then it will return only results where one of the corresponding geo scores are higher than GeographicScoreThreshold | |||||
| Delta | boolean | true or false | false | Optional. Whether to add the delta columns. This will return the difference between this week's scores and last week's scores or will return "New" if the Company Surge® data from the previous week did not match the filtering criteria for the report. | |||||
IncludeDomainOrigin | boolean | true or false | false | Optional. Whether to add the domain origin output column. This will return the country for the given company where we see the most activity for that company. | |||||
| IncludeMetroAreas | boolean | true or false | false | Optional. Whether to add the metro areas as an output column. This will return the metro areas and metro area composite score where we see activity from the given company on the given topic. | |||||
| IncludeStates | boolean | true or false | false | Optional. Whether to add the state as an output column. This will return the state/providence and state/providence composite score where we see activity from the given company on the given topic. | |||||
| IncludeCountries | boolean | true or false | false | Optional. Whether to add the country as an output column. This will return the country and country and country composite score where we see activity from the given company on the given topic. | |||||
| ReportType** | string | Value "comp" (comprehensive) or "sum" (summary) | "comp" | Optional. If not included or "comp" is specified, results include unique topic scores. If "sum" is specified, results are grouped by domain and include average topic score. Cannot include geography (country/state/metro) for "sum" reports. ** See Comments for example output. | |||||
| OutputFormat | string | Value "csv","xlsx", or "json" | "csv" | Optional. If "csv" or not specified, report will be returned in CSV format. If "xlsx", report will be returned in excel format. If "json", report will be returned in JSON format. | |||||
| AutoGen | string | Value "Weekly" or "Monthly" | None | Optional. If specified, will automatically generate a new report on every Monday (Weekly) or the Monday following the first of every month (Monthly). |
...