List Web Crawler Jobs (POST)

POST

Lists web crawler jobs.

Request

This endpoint expects an object.

created_bylist of stringsOptional

Filters for web crawler jobs created by any of the provided users.

created_dateobjectOptional

Provides ways to specify date ranges on objects.

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

The maximum number of web crawler jobs to return. The default is ‘50’.

modeenumOptional

Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_dateobjectOptional

Provides ways to specify date ranges on objects.

Response

The response to list web crawler jobs.

web_crawler_jobslist of objects

The list of jobs.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

POST

1 curl -X POST https://api.devrev.ai/web-crawler-jobs.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Successful

1 {
2   "web_crawler_jobs": [
3     {
4       "id": "id",
5       "accept_regexs": [
6         "accept_regexs",
7         "accept_regexs"
8       ],
9       "created_by": {
10         "type": "dev_user",
11         "id": "id",
12         "display_id": "display_id",
13         "display_name": "display_name",
14         "display_picture": {
15           "id": "id",
16           "file": {}
17         },
18         "email": "email",
19         "full_name": "full_name",
20         "state": "active"
21       },
22       "created_date": "created_date",
23       "description": "description",
24       "display_id": "display_id",
25       "domain_names": [
26         "domain_names",
27         "domain_names"
28       ],
29       "frequency": 1,
30       "max_depth": 1,
31       "modified_by": {
32         "type": "dev_user",
33         "id": "id",
34         "display_id": "display_id",
35         "display_name": "display_name",
36         "display_picture": {
37           "id": "id",
38           "file": {}
39         },
40         "email": "email",
41         "full_name": "full_name",
42         "state": "active"
43       },
44       "modified_date": "modified_date",
45       "no_parent": true,
46       "notify_on_complete": true,
47       "num_bytes": 1,
48       "num_timeout_urls": 1,
49       "num_urls_scraped": 1,
50       "reject_regexs": [
51         "reject_regexs",
52         "reject_regexs"
53       ],
54       "sitemap_index_urls": [
55         "sitemap_index_urls",
56         "sitemap_index_urls"
57       ],
58       "sitemap_urls": [
59         "sitemap_urls",
60         "sitemap_urls"
61       ],
62       "state": "aborted",
63       "urls": [
64         "urls",
65         "urls"
66       ]
67     },
68     {
69       "id": "id",
70       "accept_regexs": [
71         "accept_regexs",
72         "accept_regexs"
73       ],
74       "created_by": {
75         "type": "dev_user",
76         "id": "id",
77         "display_id": "display_id",
78         "display_name": "display_name",
79         "display_picture": {
80           "id": "id",
81           "file": {}
82         },
83         "email": "email",
84         "full_name": "full_name",
85         "state": "active"
86       },
87       "created_date": "created_date",
88       "description": "description",
89       "display_id": "display_id",
90       "domain_names": [
91         "domain_names",
92         "domain_names"
93       ],
94       "frequency": 1,
95       "max_depth": 1,
96       "modified_by": {
97         "type": "dev_user",
98         "id": "id",
99         "display_id": "display_id",
100         "display_name": "display_name",
101         "display_picture": {
102           "id": "id",
103           "file": {}
104         },
105         "email": "email",
106         "full_name": "full_name",
107         "state": "active"
108       },
109       "modified_date": "modified_date",
110       "no_parent": true,
111       "notify_on_complete": true,
112       "num_bytes": 1,
113       "num_timeout_urls": 1,
114       "num_urls_scraped": 1,
115       "reject_regexs": [
116         "reject_regexs",
117         "reject_regexs"
118       ],
119       "sitemap_index_urls": [
120         "sitemap_index_urls",
121         "sitemap_index_urls"
122       ],
123       "sitemap_urls": [
124         "sitemap_urls",
125         "sitemap_urls"
126       ],
127       "state": "aborted",
128       "urls": [
129         "urls",
130         "urls"
131       ]
132     }
133   ],
134   "next_cursor": "next_cursor",
135   "prev_cursor": "prev_cursor"
136 }

Create Webhook

Up Next

Built with

1	curl -X POST https://api.devrev.ai/web-crawler-jobs.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"web_crawler_jobs": [
3	{
4	"id": "id",
5	"accept_regexs": [
6	"accept_regexs",
7	"accept_regexs"
8	],
9	"created_by": {
10	"type": "dev_user",
11	"id": "id",
12	"display_id": "display_id",
13	"display_name": "display_name",
14	"display_picture": {
15	"id": "id",
16	"file": {}
17	},
18	"email": "email",
19	"full_name": "full_name",
20	"state": "active"
21	},
22	"created_date": "created_date",
23	"description": "description",
24	"display_id": "display_id",
25	"domain_names": [
26	"domain_names",
27	"domain_names"
28	],
29	"frequency": 1,
30	"max_depth": 1,
31	"modified_by": {
32	"type": "dev_user",
33	"id": "id",
34	"display_id": "display_id",
35	"display_name": "display_name",
36	"display_picture": {
37	"id": "id",
38	"file": {}
39	},
40	"email": "email",
41	"full_name": "full_name",
42	"state": "active"
43	},
44	"modified_date": "modified_date",
45	"no_parent": true,
46	"notify_on_complete": true,
47	"num_bytes": 1,
48	"num_timeout_urls": 1,
49	"num_urls_scraped": 1,
50	"reject_regexs": [
51	"reject_regexs",
52	"reject_regexs"
53	],
54	"sitemap_index_urls": [
55	"sitemap_index_urls",
56	"sitemap_index_urls"
57	],
58	"sitemap_urls": [
59	"sitemap_urls",
60	"sitemap_urls"
61	],
62	"state": "aborted",
63	"urls": [
64	"urls",
65	"urls"
66	]
67	},
68	{
69	"id": "id",
70	"accept_regexs": [
71	"accept_regexs",
72	"accept_regexs"
73	],
74	"created_by": {
75	"type": "dev_user",
76	"id": "id",
77	"display_id": "display_id",
78	"display_name": "display_name",
79	"display_picture": {
80	"id": "id",
81	"file": {}
82	},
83	"email": "email",
84	"full_name": "full_name",
85	"state": "active"
86	},
87	"created_date": "created_date",
88	"description": "description",
89	"display_id": "display_id",
90	"domain_names": [
91	"domain_names",
92	"domain_names"
93	],
94	"frequency": 1,
95	"max_depth": 1,
96	"modified_by": {
97	"type": "dev_user",
98	"id": "id",
99	"display_id": "display_id",
100	"display_name": "display_name",
101	"display_picture": {
102	"id": "id",
103	"file": {}
104	},
105	"email": "email",
106	"full_name": "full_name",
107	"state": "active"
108	},
109	"modified_date": "modified_date",
110	"no_parent": true,
111	"notify_on_complete": true,
112	"num_bytes": 1,
113	"num_timeout_urls": 1,
114	"num_urls_scraped": 1,
115	"reject_regexs": [
116	"reject_regexs",
117	"reject_regexs"
118	],
119	"sitemap_index_urls": [
120	"sitemap_index_urls",
121	"sitemap_index_urls"
122	],
123	"sitemap_urls": [
124	"sitemap_urls",
125	"sitemap_urls"
126	],
127	"state": "aborted",
128	"urls": [
129	"urls",
130	"urls"
131	]
132	}
133	],
134	"next_cursor": "next_cursor",
135	"prev_cursor": "prev_cursor"
136	}