Get list of Actors
Gets the list of all Actors that the user created or used. The response is a list of objects, where each object contains a basic information about a single Actor.
To only get Actors created by the user, add the my=1 query parameter.
The endpoint supports pagination using the limit and offset parameters and it will not return more than 1000 records.
By default, the records are sorted by the createdAt field in ascending order, therefore you can use pagination to incrementally fetch all Actors while new ones are still being created. To sort the records in descending order, use the desc=1 parameter.
You can also sort by your last run by using the sortBy=stats.lastRunStartedAt query parameter. In this case, descending order means the most recently run Actor appears first.
Query parameters
If true or 1 then the returned list only contains Actors owned by the user. The default value is false.
Number of items that should be skipped at the start. The default value is 0.
Maximum number of items to return. The default value as well as the maximum is 1000.
If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.
Field to sort the records by. The default is createdAt. You can also use stats.lastRunStartedAt to sort by the most recently ran Actors.
Response
Example response
{
"data": {
"total": 1,
"limit": 1000,
"count": 1,
"items": [
{
"id": "br9CKmk457",
"createdAt": "2019-10-29T07:34:24.202Z",
"modifiedAt": "2019-10-30T07:34:24.202Z",
"name": "MyAct",
"username": "janedoe",
"title": "Hello World Example",
"stats": {
"totalBuilds": 9,
"totalRuns": 16,
"totalUsers": 6,
"totalUsers7Days": 2,
"totalUsers30Days": 6,
"totalUsers90Days": 6,
"totalMetamorphs": 2,
"lastRunStartedAt": "2019-07-08T14:01:05.546Z",
"actorReviewCount": 69,
"actorReviewRating": 4.7,
"bookmarkCount": 1269,
"publicActorRunStats30Days": {
"ABORTED": 2542,
"FAILED": 1234,
"SUCCEEDED": 732805,
"TIMED-OUT": 12556,
"TOTAL": 749137
}
}
}
]
}
}