/reporting/api/v1/agent/list

AgentID List from Reporting API

Parameters

  • StartDateTime - When to start pulling data from API.
  • EndDateTime - When to stop pulling data from API.
  • RelativePeriodStart - To start query one of multiple days in the future, 1,2, etc. or to do in past -1, -2, etc.
  • RelativePeriodEnd - To end query one of multiple days in the future, 1,2, etc. or to do in past -1, -2, etc.
  • RelativeTime Zones For API information about Times Zone, please visit this page on Time Zones.
  • Resolution - Size periods of the request. Can be by quarter hour, 1 hour, or 1 day.
  • Limit - Limits the number of returns from API request.
  • Offset - This value goes along with Limit. The offset is where the limit starts.
    • Ex. A user wants 10 results, but doesn't want the first 15 displayed. A Limit of "10" and an Offset of "15" would give results 16 through 25.

Responses available:

  • 200
  • 401
  • 403

Example return:

{
  "resultCode": 0,
  "resultCodeName": "Success",
  "data": [
    10614,
    10654,
    11441,
    11442,
    11451,
    13619,
    13620,
    13621,
    13622,
    13623,
    13624,
    13625,
    13626,
    13627,
    13628,
    13629,
    13630,
    13631,
    13632,
    13633,
    13634,
    13635,
    13636,
    13637,
    13638,
    13639,
    13640,
    13641,
    13642,
    13643,
    13644,
    13645,
    13646,
    13647,
    13648,
    13649,
    13650,
    13651,
    13652,
    13653,
    13654,
    13655,
    13656,
    13657,
    13658,
    13659,
    13660,
    13661,
    13662,
    13663,
    13664,
    13665,
    13666,
    13667,
    13668,
    13670,
    13671,
    13672,
    13673,
    13674,
    13675,
    13676,
    13677,
    13678,
    13679,
    13680,
    13681,
    13682,
    13683,
    13684,
    13685,
    13686,
    13687,
    13688,
    13689,
    13690,
    13691,
    13692,
    13693,
    13694,
    13695,
    13696,
    13697,
    13698,
    13699,
    13700,
    13701,
    13702,
    13703,
    13704,
    13705,
    13706,
    13707,
    13708,
    13709,
    13710,
    13711,
    13712,
    13713,
    13714,
    13715,
    13716,
    13717,
    13718,
    13719,
    13720,
    13721,
    13722
  ],
  "dataType": "Int64",
  "paging": {
    "total": 108,
    "limit": 5,
    "offset": 0
  },
  "hasPaging": true
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!