SPsponsorunited
PhantomBuster monitor

Recent containers of the given phantoms, reduced to their shape

Passed on to social-platforms-api, which holds the PhantomBuster key and reduces each container to its shape. Each phantom carries its own ok/error, so one failing phantom leaves the others intact. When social-platforms-api itself fails, the answer is a 502 or 504, never an empty list. Requires the phantombuster-monitor-read permission.

post/api/phantombuster-monitor/containers

Request

  • Base URL
    https://api.sponsorunited.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

agentIdsstring[] required

Phantom ids, as strings: several are larger than JavaScript can hold exactly as a number. Between 1 and 50, no repeats; each one is a separate PhantomBuster call.

lookbackHoursnumber nullable

How far back to look for finished containers. Defaults to 24.

limitinteger nullable

Containers to read per phantom. Defaults to 50.

beforeEndedAtinteger nullable

Epoch milliseconds: the nextBeforeEndedAt of a previous response, to read the next page.

includeResultObjectboolean nullable

Also return the shape of the result object of each phantom's most recent containers. Defaults to false.

Example request

{
  "agentIds": [
    "2464817048072030"
  ]
}

Response

One result per phantom

Example response

{
  "results": [
    {
      "agentId": "54298",
      "ok": true
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.