Agent.GetList
  • 25 May 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Agent.GetList

  • Dark
    Light
  • PDF

Article Summary

Description

Returns a list of your agents with their ID, Name, Settings, Description, and other important information.

URL parameters

NameRequiredTypeDescription
IncludeStartingURLFalsebooleanWhether the response should include the staring URL of the agent. Default is False.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.
AgentAgentInformation on all agents in the account.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.GetList"

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<AgentGetListResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
	<AgentList>
		<Agent>
			<Created>2008-06-21 08:45:32</Created>
			<Modified />
			<AgentID>1001</AgentID>
			<Name>My First Agent</Name>
			<Description>This is my first agent</Description>
			<Settings />
			<StartingURL>http://mozenda.com/builderwelcome</StartingURL>
            <Status>Error</Status>
		</Agent>
		<Agent>
			<Created>2008-06-23 14:20:49</Created>
			<Modified />
			<AgentID>1003</AgentID>
			<Name>Scraped Data</Name>
			<Description />
			<Settings />
			<StartingURL>http://mozenda.com/builderwelcome</StartingURL>
            <Status>Ready</Status>
		</Agent>
	</AgentList>
</AgentGetListResponse>

JSON (add &ResponseFormat=JSON)

{
   "Agent":[
      {
         "Created":"2018-02-23 15:16:04",
         "Modified":"2018-03-05 09:39:12",
         "AgentID":1004,
         "Name":"Player-ActiveList-02",
         "Description":"",
         "Settings":"BrowserIsolation, MaximizeBrowserWindow, SingleBrowser, StopOnHarvestingError, UseAnonymizer",
         "Status":"Ready"
      },
      {
         "Created":"2018-02-26 09:05:11",
         "Modified":"2018-02-26 09:05:11",
         "AgentID":1005,
         "Name":"Movies-Intl-Gross",
         "Description":"",
         "Settings":"BrowserIsolation, MaximizeBrowserWindow, SingleBrowser, UseAnonymizer",
         "Status":"Ready"
      },
      {
         "Created":"2018-03-05 09:20:27",
         "Modified":"2018-03-05 09:20:27",
         "AgentID":1006,
         "Name":"Player-ActiveList-01",
         "Description":"",
         "Settings":"BrowserIsolation, MaximizeBrowserWindow, SingleBrowser",
         "Status":"Ready"
      },
   ],
   "JsonResult":{
      "Command":"Agent.GetList",
      "AutoLoggedIn":false,
      "WebConsoleKey":"",
      "Result":"Success",
      "ErrorCode":"",
      "ErrorDescription":"",
      "ErrorList":[

      ],
      "ExecutionTime":{
         "Ticks":0,
         "Days":0,
         "Hours":0,
         "Milliseconds":0,
         "Minutes":0,
         "Seconds":0,
         "TotalDays":0,
         "TotalHours":0,
         "TotalMilliseconds":0,
         "TotalMinutes":0,
         "TotalSeconds":0
      }
   }
}

Was this article helpful?

What's Next