The REST API is available to all Enterprise customers.
Some of the responses from from the REST API include objects with various attributes. These API response objects are listed below.
Agent
Name
Type
Description
AgentID
numeric
Unique identifier of the agent.
SourcesCollection
string
List of collections (comma-separated if more than one) which the agent sources to.
Created
datetime
Date and time when the agent is created.
Modified
datetime
Date and time that the agent was last modified.
Name
string
Name of the agent.
Description
string
Description of the agent.
Settings
string
Settings of the agent.
StartingURL
string
Starting URL of the agent.
Status
string
The status of the agent.
Agent (Combined Collections)
Name
Description
AgentID
Unique identifier of the agent.
SourcesCollection
List of collections (comma-separated if more than one) which the agent sources to.
Cookie Store
Name
Type
Description
Name
string
The name of the cookie store.
Description
string
A description of the cookie store.
ItemID
numeric
Unique identifier of the cookie store.
Created
string
Date and time when the cookie store is created.
CreatedBy
string
The user who created the cookie store.
Cookies
Name
Type
Description
temID
numeric
Unique identifier of the cookie.
CookieStoreID
numeric
Unique identifier of the cookie store.
Settings
string
Settings for the cookie.
Name
string
The cookie name.
Value
string
The cookie value.
Domain
string
The cookie domain.
Expires
string
The cookie expiration date.
TimeStamp
string
Date and time attached to the cookie.
HttpOnly
boolean
Flag which tells the browser that the cookie should only be accessed by the server.
Secure
boolean
Flag which tells the browser only to provide the cookie if the request is transmitted over HTTPS.
Path
string
Path attached to the cookie.
Version
string
Version attached to the cookie.
Comment
string
Comments on the cookie.
CommentUri
string
Optional comment representing entended usage of the URL.
Port
numeric
TCP ports that the cookie applies to.
Collection
Name
Type
Description
CollectionID
numeric
Unique identifier of the collection.
Name
string
Name of the collection.
Description
string
A description of the collection.
DefaultViewID
numeric
Unique identifier for the default view of the collection.
AgentID
numeric
Unique identifier for the agent that corresponds to the collection.
Collection (Publisher)
Universal fields
Name
Type
Description
CollectionName
string
Name of the collection.
CollectionID
numeric
Unique identifier of the collection.
AgentID
numeric
Unique identifier of the agent.
PublishWhenAgentCompletes
boolean
Yes if the corresponding agent should publish when it completes running.
Created
string
Date and time when the agent is created.
CreatedBy
string
Who created the agent.
Description
string
Description of the collection.
ViewID
numeric
Unique identifier of the view.
BookmarkID
numeric
The ID of the bookmark you're publishing from (usually 0).
FileFormat
string
Publishing file format (CSV, TSV, XML, JSON, XLSX).
FileName
string
The published file name (user specified).
FileIncludeHeader
boolean
True if the published file should include headers.
Method
string
The selected method of publishing.
IncludePackages
boolean
True if file packages should be published with the data.
ItemStatusIncludeColumn
boolean
True if item status columns should be included.
ItemStatusIncludeAdded
boolean
True if the added item status column should be included.
ItemStatusIncludeChanged
boolean
True if the changed item status column should be included.
ItemStatusIncludeUnchaged
boolean
True if the unchanged item status column should be included.
ItemStatusIncludeRemoved
boolean
True if the removed item status column should be included.
ItemStatusIncludeChangeMarkup
boolean
True if change markup will be included.
SearchText
string
Gives ability to filter results further (as though you had entered something in a collection's search box in the Web Console).
SearchField
string
The field that SearchText searches in. By default, searches all fields.
FileCompressionFormat
string
The compression formats of the data file that will be sent. Options are GZip, SevenZip, and Zip. Defaults to no compression.
FilePackageCompressionFormat
string
The compression formats of the package file that will be sent. FilePacakgeCompressionFormat will only be used if IncludePackages is true. Options are TarGZip, SevenZip, Tar and Zip. The default for FilePackageCompressionFormat is Zip.
FTP fields
Name
Type
Description
FtpServer
string
The FTP server address.
FtpPort
numeric
The port.
FtpDirectory
string
The directory path.
FtpUser
string
The FTP user.
FtpPassword
string
The password.
FtpUsePassive
boolean
Whether to use passive mode. Yes/True or No/False.
FtpProtocol
string
The FTP protocol.
FtpSSLProtocol
string
The SSL Protocol to use.
Email fields
Name
Type
Description
EmailAddress
string
The email address to send the data to.
EmailSubject
string
The subject of the email.
Amazon S3 fields
Name
Type
Description
AmazonS3AuthenticationToken
string
The access key for the AWS account or IAM user.
AmazonS3SignRequestToken
string
The secret key for the AWS account or IAM user.
AmazonS3BucketPath
string
The S3 bucket path.
AmazonS3BucketRegion
string
The S3 bucket region.
Azure Storage fields
Name
Type
Description
MicrosoftAzureStorageAccountName
string
The Azure Storage account name.
MicrosoftAzureStorageAccountKey
string
The Azure account key.
MicrosoftAzureStorageContainerName
string
The blob container name.
Dropbox fields
Name
Type
Description
DropboxAccount
string
The email address associated with the Dropbox account.
DropboxFolder
string
The folder path.
Google Drive fields
Name
Type
Description
GoogleAccount
string
The email address associated with the Google Drive account.
GoogleFolder
string
The folder path.
Schedule
Universal fields
Name
Type
Description
AgentID or SequenceID
numeric
Unique identifier for the agent or sequence.
Frequency
string
None, Once, Interval, Daily, EveryWeekday, Weekly, or Monthly.
Starts
datetime
The datetime the schedule starts. yyyy-MM-dd hh:mm:ss
Interval
Name
Type
Description
RepeatInterval
numeric
The interval the schedule repeats on in minutes.
Ends
datetime
The datetime the schedule stops. Leave blank for never. yyyy-MM-dd hh:mm:ss
Daily
Name
Type
Description
RepeatEvery
numeric
Repeat every __ days. E.g. 3
RepeatInterval
numeric
The interval the schedule repeats on in minutes.
Ends
datetime
The datetime the schedule ends. Leave blank for never. yyyy-MM-dd hh:mm:ss
Every Weekday
Name
Type
Description
RepeatEvery
numeric
Repeat every __ weeks. E.g. 3.
RepeatInterval
numeric
The interval the schedule repeats on in minutes.
RepeatIntervalHour
numeric
How many hours do you want the RepeatInterval to repeat? Between 1 and 24.
Ends
datetime
The datetime the schedule ends. Leave blank for never. yyyy-MM-dd hh:mm:ss
Weekly
Name
Type
Description
RepeatEvery
numeric
Repeat every __ days. E.g. 3
RunOn
string
Comma delimited list of which weekdays the schedule runs on.
RepeatInterval
numeric
The interval the schedule repeats on in minutes.
RepeatIntervalHour
numeric
How long the RepeatInterval will go for. Number between 1 and 24.
Ends
datetime
The datetime the schedule ends. yyyy-MM-dd hh:mm:ss
Monthly
Name
Type
Description
RepeatEvery
numeric
Repeat every __ days.
RepeatBy
string
Either Day or DayOfWeek.
RepeatInterval
numeric
The interval the schedule repeats on in minutes.
RepeatIntervalHour
numeric
The number of hours the RepeatInterval continues.
Ends
datetime
The datetime the schedule ends. yyyy-MM-dd hh:mm:ss
Field
Name
Type
Description
FieldID
numeric
Unique identifier for the field.
CollectionID
numeric
Unique identifier for the collection the field belongs to.
Name
string
The name of the field.
Description
string
A description for the field.
Format
string
The format of the field (Text, DateTime, URL, File, or Number).
IsSystem
boolean
Whether or not the field is a System (not user-created) field.
IsUnique
boolean
Whether or not the field is set as a unique field.
Job
Name
Type
Description
ActiveJob
boolean
If the job is in any status other than Done.
Created
datetime
Date and time when the job is created.
Modified
datetime
Date and time when the job was last modified.
ItemSourceName
string
The name of the source of the item.
JobID
numeric
Unique identifier of the job.
Name
string
Name of the job.
Description
string
A description of the job.
JobType
string
Type of job, e.g. WebPageHarvest for jobs which run an agent.
State
string
Internal field indicating the job's state.
Status
string
The status of the job. A more cleaned up version of State.
Command
string
System field indicating different activity triggers for the job (e.g. Stop, Start ) from a user, schedule, or sequence step.
Start
string
Date and time when a postponed job should start.
Started
string
Date and time when the job started.
Ended
string
Date and time when the job ended.
JobRestriction
string
For WebPageHarvestjobs, the domain they run against.
JobKey
string
A guide unique identifier for the job.
ScheduleID
string
System field indicating the ID of the schedule which created the job.
ScheduleItemType
string
System field indicating the type of the scheduled item.
ScheduleItemID
string
The AgentID for job type WebPageHarvest. The CollectionID for job types ReportRefreshData and CollectionUniquesRebuild. The ID of the publisher for publish** jobs**.
ErrorCode
string
The most recent error code thrown by the job.
ErrorMessage
string
Explanation of the most recent error thrown by the job.
ErrorDetail
string
Detailed explanation of the most recent error thrown by the job.
ErrorFirst
string
Dateand time of the first error the job encountered.
ErrorLast
string
Date and time of the most recent error the job encountered.
ErrorCount
numeric
The number of errors the job has encountered.
WarningFirst
string
Date and time of the first warning the job encountered.
WarningLast
string
Date and time of the most recent warning the job has encountered.
WarningCount
string
The number of warnings the job has encountered.
BatchID
numeric
Unique identifier of the batch of jobs this job is associated with.
BatchOrder
numeric
The order of the job in its batch.
SequenceID
numeric
Unique identifier for the sequence that started the job.
Duration
numeric
The number of seconds the job has been running (not queued, errored, paused, etc.).
List
Name
Type
Description
ListName
string
Name of the agent, view, and ViewID.
AgentPage
numeric
Page that the agent is currently on.
Type
string
Action type that the agent is on.
RestartItemIndex
numeric
The index of the list the agent was on when the job stopped.
Active Job
Name
Type
Description
JobID
numeric
Unique identifier of the job.
Status
string
The status of the job. A more cleaned up version of State.
JobType
string
Type of job, e.g. WebPageHarvest for jobs which run an agent.
AgentID
string
Unique identifier of the agent.
Rebuild Job
Name
Type
Description
JobID
numeric
Unique identifier of the job.
JobType
string
Type of job, e.g. CollectionCombinedRebuild for jobs which run an are combining the collections.
Status
string
The status of the job. A more cleaned up version of State.
CollectionID
string
Unique identifier of the collection.
Sequences
Name
Type
Description
ItemID
numeric
Unique identifier of the sequence.
Name
string
Name of the sequence.
Status
string
Current status of the sequence (e.g. Done, Paused, Queued, etc).
Config
string
Steps included in the sequence.
Progress
string
If running or paused, the name of the step that the sequence is currently on.
NextRunTime
datetime
Date and time the sequence is scheduled to run.
LastRunTime
datetime
Date and time the sequence last ran.
LastRunResult
string
The result the last time the sequence was run (e.g. Done, Cancelled).
Step
Name
Type
Description
SequenceStepID
numeric
Unique identifier of the sequence step.
StepNumber
numeric
The order that the step is executed within the sequence. The step number is shared by steps that run concurrently.
Step
string
The name of the step.
Config
string
Configuration settings set by the user.
Status
string
Current status of the step (e.g. Done, Paused, Queued, etc.).
Progress
string
Functions only if the agent uses a Data List. If running or paused, the percentage of inputs in the Data List that have been processed (e.g. 3 out of 4 items (75%))
StepType
string
Type of step (e.g. Run agent, Clear collection, Publish a collection, etc).
StepItemID
numeric
Unique identifier of the specific item that the step acts against. E.g. for an AgentRun step this is the AgentID.
Settings
string
Settings set by the user.
AgentRun
Name
Type
Description
AgentID
numeric
Unique identifer of the agent.
ConcurrentJobs
numeric
Number of jobs set to run concurrently. Default is 1.
ResumeErrorCount
numeric
Number of times the sequenceresumes errors before the sequence errors.
ResumeErrorCodes
string
Types of errors that the agent should resume when encountered in a comma delimited list.
StepParameter.<ParamName>
string
Set the value of a parameter name to a parameter value. Add as many parameters as necessary.
ClearCollection
Name
Type
Description
CollectionID
numeric
Unique identifer of the collection.
DeleteItems
boolean
Yes, No, True, False - Yes/True to delete all items for the collection. Default is No.
DeleteJobHistory
boolean
Yes, No, True, False - Yes/True to delete all job history for the collection. Default is No.
DeleteImagesFiles
boolean
Yes, No, True, False - Yes/True to delete all images and files for the collection. Default is No.
DeleteFilePackages
boolean
Yes, No, True, False - Yes/True to delete all file packages for the collection. Default is No.
