Skip to content

Commit 8c7bf56

Browse files
authored
docs: Add openapi specs for startedAt actor run filters (#1934)
1 parent af0df7d commit 8c7bf56

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

apify-api/openapi/paths/actor-runs/actor-runs.yaml

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ get:
1212
By default, the records are sorted by the `startedAt` field in ascending
1313
order. Therefore, you can use pagination to incrementally fetch all records while
1414
new ones are still being created. To sort the records in descending order, use
15-
`desc=1` parameter. You can also filter runs by status ([available
15+
`desc=1` parameter. You can also filter runs by `startedAt`` and `status`` fields ([available
1616
statuses](https://docs.apify.com/platform/actors/running/runs-and-builds#lifecycle)).
1717
operationId: actorRuns_get
1818
parameters:
@@ -58,6 +58,28 @@ get:
5858
schema:
5959
type: string
6060
example: SUCCEEDED
61+
- name: startedAfter
62+
in: query
63+
description: |
64+
Filter runs that started after the specified date and time (inclusive).
65+
The value must be a valid ISO 8601 datetime string (UTC).
66+
style: form
67+
explode: true
68+
schema:
69+
type: string
70+
format: date-time
71+
example: "2025-09-01T00:00:00.000Z"
72+
- name: startedBefore
73+
in: query
74+
description: |
75+
Filter runs that started before the specified date and time (inclusive).
76+
The value must be a valid ISO 8601 datetime string (UTC).
77+
style: form
78+
explode: true
79+
schema:
80+
type: string
81+
format: date-time
82+
example: "2025-09-17T23:59:59.000Z"
6183
responses:
6284
# todo 404?
6385
'200':

apify-api/openapi/paths/actors/acts@{actorId}@runs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,28 @@ get:
6666
schema:
6767
type: string
6868
example: SUCCEEDED
69+
- name: startedAfter
70+
in: query
71+
description: |
72+
Filter runs that started after the specified date and time (inclusive).
73+
The value must be a valid ISO 8601 datetime string (UTC).
74+
style: form
75+
explode: true
76+
schema:
77+
type: string
78+
format: date-time
79+
example: "2025-09-01T00:00:00.000Z"
80+
- name: startedBefore
81+
in: query
82+
description: |
83+
Filter runs that started before the specified date and time (inclusive).
84+
The value must be a valid ISO 8601 datetime string (UTC).
85+
style: form
86+
explode: true
87+
schema:
88+
type: string
89+
format: date-time
90+
example: "2025-09-17T23:59:59.000Z"
6991
responses:
7092
'200':
7193
description: ''

0 commit comments

Comments
 (0)