apify-docs/apify-api/openapi/components/schemas/request-queues/RequestQueue.yaml at 3bf82b6ed27daba9fba93192c4230534552b5010 · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
title: RequestQueue
description: A request queue object containing metadata and statistics.
required:
  - id
  - userId
  - createdAt
  - modifiedAt
  - accessedAt
  - totalRequestCount
  - handledRequestCount
  - pendingRequestCount
  - hadMultipleClients
  - consoleUrl
type: object
properties:
  id:
    type: string
    description: A unique identifier assigned to the request queue.
    examples: [WkzbQMuFYuamGv3YF]
  name:
    type: string
    description: The name of the request queue.
    examples: [some-name]
  userId:
    type: string
    description: The ID of the user who owns the request queue.
    examples: [wRsJZtadYvn4mBZmm]
  createdAt:
    type: string
    format: date-time
    description: The timestamp when the request queue was created.
    examples: ["2019-12-12T07:34:14.202Z"]
  modifiedAt:
    type: string
    format: date-time
    description: The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue.
    examples: ["2030-12-13T08:36:13.202Z"]
  accessedAt:
    type: string
    format: date-time
    description: The timestamp when the request queue was last accessed.
    examples: ["2019-12-14T08:36:13.202Z"]
  totalRequestCount:
    type: integer
    description: The total number of requests in the request queue.
    minimum: 0
    examples: [870]
  handledRequestCount:
    type: integer
    description: The number of requests that have been handled.
    minimum: 0
    examples: [100]
  pendingRequestCount:
    type: integer
    description: The number of requests that are pending and have not been handled yet.
    minimum: 0
    examples: [670]
  hadMultipleClients:
    type: boolean
    description: Whether the request queue has been accessed by multiple different clients.
    examples: [true]
  consoleUrl:
    type: string
    description: The URL to view the request queue in the Apify console.
    format: uri
    examples: [https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC]
  stats:
    $ref: ./RequestQueueStats.yaml
  generalAccess:
    $ref: ../common/GeneralAccess.yaml