{"info":{"_postman_id":"81c8b9f6-3c89-44ee-8950-8adb41709fa5","name":"Grepsr APIs","description":"

Send requests to the Grepsr app remotely. Get all data access functionalities of the app from within your API tool — query collected data, manage scheduling and even run reports on-demand!!

Authorization

All API requests require an X-Api-Key header for authentication.

How to Get Your API Key

Log in to your Grepsr account.
\n
Navigate to Profile.
\n
Locate your API Key under the Personal Details section.
\n

Using the API Key

Include it in the headers of every request:

X-Api-Key: {{your_api_key}}\n\n

Security Note: Treat your API key as sensitive—avoid exposing it in client-side code or public repositories.

Rate Limiting

To ensure fair usage, the API enforces rate limits.

Current Limits

100 requests per minute per user (across all endpoints).
\n
Exceeding this limit returns a 429 Too Many Requests error.
\n

Rate Limit Headers

Each response includes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
`x-ratelimit-limit-minute`	Maximum allowed requests per minute.
`x-ratelimit-remaining-minute`	Remaining requests in the current window.

Handling Rate Limits

Check remaining requests before making additional calls.
\n
Implement exponential backoff if you hit a 429 response.
\n
Cache responses where possible to reduce API calls.
\n

Variables

Variable(s) used in this documentation:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Value	Description
`{{apikey}}`	`X-API-Key`	Your personal API key, available in the Account section in the app

IMPORTANT

Replace all instances of {{your_api_key}} with whatever variable name you choose for your personalized values while executing the requests.
\n
Unless otherwise specified, add https://api.grepsr.com as the URL prefix for each request.
\n
For each request to work, make sure you enter project_id, report_id, history_id, service_id, etc. of a project that YOU own!
\n

Key Concepts

To query data directly via our API, it is important to understand certain concepts. We have tried to explain every basic concept using Excel as an analogy.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Record	Individual data row in a report.
Report	A collection of records; like a folder which contains crawled data.
History	Individual batch of a crawl run. When a crawler runs, it uses a report's specification to create a run history. One history is equivalent to one Excel file/workbook.
Project	A collection of reports.

Errors

Common Errors:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Response Body Message	Description
400	`Required parameter not supplied`	Bad Request
401	`No API key found in request`	Unauthorized
404	`Not Found`	Page Not Found
429	`Too Many Requests`	Too Many Requests(RateLimit exceeded)
500	`Internal server error`	Internal Server Error

Error Response Format

{\n  \"status\": false,\n  \"message\": \"Error description\",\n  \"payload\": null\n}\n\n

Best Practices

✅ Store your API key securely (environment variables, secret managers).
✅ Monitor rate limits using response headers.
✅ Implement retry logic for failed requests (with delays).
✅ Use pagination when fetching large datasets.

Support

For higher rate limits or troubleshooting, contact Grepsr Support(support@grepsr.com).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authorization","slug":"authorization"},{"content":"Rate Limiting","slug":"rate-limiting"},{"content":"Variables","slug":"variables"},{"content":"Key Concepts","slug":"key-concepts"},{"content":"Errors","slug":"errors"}],"owner":"31997238","collectionId":"81c8b9f6-3c89-44ee-8950-8adb41709fa5","publishedId":"2s9Ykt5eaS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-15T05:26:02.000Z"},"item":[{"name":"Projects","item":[{"name":"List Projects","id":"46a314a5-6b66-4200-82ba-b1421e62f8b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"project_type\" : \"WEBAPP\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/project/list","description":"

Get a list of all your projects.

\n","urlObject":{"path":["v1","project","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0467d269-3391-4b3e-8745-6f50bbcfa925","name":"List Projects","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"project_type\" : \"WEBAPP\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/project/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Thu, 04 Jan 2024 11:31:36 GMT"},{"key":"server","value":"uvicorn"},{"key":"content-length","value":"5962"},{"key":"content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"payload\": [\n {\n \"id\": {{your-project-id}},\n \"name\": \"Test Project789\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2024-01-04 11:25:49\",\n \"modified\": \"2024-01-04 11:25:49\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Testafkljfs\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2024-01-03 08:47:27\",\n \"modified\": \"2024-01-03 08:47:27\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"HelloTest2\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2024-01-03 05:53:32\",\n \"modified\": \"2024-01-03 05:53:32\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Test Organizaion\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2024-01-03 05:50:12\",\n \"modified\": \"2024-01-03 05:50:12\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Test Project\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-12-27 15:43:43\",\n \"modified\": \"2023-12-27 15:43:43\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Test App\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-11-20 10:45:21\",\n \"modified\": \"2023-11-20 10:45:21\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"One-time\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"invitetest\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-11-20 09:47:04\",\n \"modified\": \"2023-11-20 09:47:04\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"One-time\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"OrgInviteTest\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-11-20 08:50:46\",\n \"modified\": \"2023-11-20 08:50:46\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"One-time\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Test1234EventTestt\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-10-01 13:57:12\",\n \"modified\": \"2023-10-01 13:57:12\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Test123\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-10-01 12:41:23\",\n \"modified\": \"2023-10-01 12:41:23\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Bye ACL\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2023-09-13 12:07:55\",\n \"modified\": \"2023-09-13 12:07:55\",\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n },\n {\n \"id\": {{your-project-id}},\n \"name\": \"Testing project (Only For Dev)\",\n \"description\": \"irure anim\",\n \"status\": \"PENDING\",\n \"type\": \"WEBAPP\",\n \"created\": \"2022-01-10 08:24:49\",\n \"modified\": \"2022-02-16 05:06:36\",\n \"reports\": [\n {\n \"id\": {{your-report-id}},\n \"name\": \"Jawaan\",\n \"nextUpdate\": \"None\",\n \"historyStatus\": \"PROCESSING\",\n \"lastHistoryDate\": \"2023-09-27 06:39:59\",\n \"notificationTypes\": [\n \"EMAIL\"\n ]\n }\n ],\n \"projectStatus\": \"Active\",\n \"projectScheduleType\": \"Recurring\"\n }\n ],\n \"message\": \"OK\"\n}"}],"_postman_id":"46a314a5-6b66-4200-82ba-b1421e62f8b9"}],"id":"3c0c32df-abb8-4960-95e1-4a5858702c26","description":"

A project is a vehicle through which customer requirements are translated into workable data and value is delivered. A project is a space where all the client requirements are captured.

Basically, project is the collection of crawlers.

\n","_postman_id":"3c0c32df-abb8-4960-95e1-4a5858702c26"},{"name":"Reports","item":[{"name":"ListHistories","event":[{"listen":"test","script":{"id":"667268cc-4b5d-42a9-a197-7ff207df8397","exec":["pm.test(\"Response is ordered by ID\", function () {"," var jsonData = pm.response.json();",""," // Assuming jsonData is an array of objects with an 'id' property"," for (let i = 0; i < jsonData.length - 1; i++) {"," pm.expect(jsonData[i].id).to.be.below(jsonData[i + 1].id);"," }","});",""],"type":"text/javascript"}}],"id":"66cd4fc7-e626-4cea-a285-06c48b5af5a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\":{{your-report-id}},\n \"size\":2\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/history/list","description":"

List the runs of the report. A run of the report is called history.

\n","urlObject":{"path":["v1","report","history","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d7f71b6d-9c30-45ed-9cd6-5e6ba31b9767","name":"ListHistories","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\":{{your-report-id}},\n \"size\":2\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/history/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"666"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.8.1"},{"key":"Date","value":"Fri, 15 Dec 2023 16:36:43 GMT"},{"key":"X-Kong-Upstream-Latency","value":"5"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"payload\": [\n {\n \"history_id\": {{your-history-id}},\n \"status\": \"SUCCESS\",\n \"item_count\": 0,\n \"request_count\": 227,\n \"run_params\": {},\n \"bandwidth_upload\": 64418,\n \"bandwidth_download\": 4882063,\n \"csv_file\": \"https://your-data-link/oJElX0e\",\n \"run_started\": \"2023-06-29T09:36:58\",\n \"run_ended\": \"2023-06-29T09:43:58\",\n \"created\": \"2023-06-29T09:36:58\",\n \"modified\": \"2023-06-29T09:43:58\"\n },\n {\n \"history_id\": {{your-history-id}},\n \"status\": \"SUCCESS\",\n \"item_count\": 2488,\n \"request_count\": 126,\n \"run_params\": {},\n \"bandwidth_upload\": 25022,\n \"bandwidth_download\": 1984907,\n \"csv_file\": \"https://your-data-link/oJElX0e\",\n \"run_started\": \"2023-06-30T09:49:25\",\n \"run_ended\": \"2023-06-30T09:56:22\",\n \"created\": \"2023-06-30T09:49:25\",\n \"modified\": \"2023-06-30T09:56:22\"\n }\n ],\n \"message\": \"OK\"\n}"}],"_postman_id":"66cd4fc7-e626-4cea-a285-06c48b5af5a9"},{"name":"Run Report","id":"7521f9aa-f946-4461-b0ba-6f094a804316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\": {{your-report-id}},\n \"run_params\": {\n \"PaaramName1\": \"ParamValue1\",\n \"ParamName2\": \"ParamValue2\",\n \"ParamName3\": \"ParamValue3\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/run","description":"

Run the report(crawler) to scrape data. You can later get the data on the delivery destination you have set on platform.

\n","urlObject":{"path":["v1","report","run"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b9a57a70-8bdb-440a-9780-8ede5d23154b","name":"Run Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"report_id\": {{your-report-id}},\n \"run_params\": {\n \"PaaramName1\": \"ParamValue1\",\n \"ParamName2\": \"ParamValue2\",\n \"ParamName3\": \"ParamValue3\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/run"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"107"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Fri, 15 Dec 2023 16:24:16 GMT"},{"key":"server","value":"uvicorn"},{"key":"X-Kong-Upstream-Latency","value":"160"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Report run will start shortly\",\n \"payload\": {\n \"project_id\": {{your-project-id}},\n \"report_id\": {{your-report-id}}\n }\n}"}],"_postman_id":"7521f9aa-f946-4461-b0ba-6f094a804316"},{"name":"StopRun","id":"ce412ec5-8dc5-4bf2-a82e-cd397248c301","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\":{{your-report-id}},\n \"history_id\":{{your-history-id}}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/stop","description":"

Stop the running report(crawler) by teminating all the process and jobs.

\n","urlObject":{"path":["v1","report","stop"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"e04e6675-eea6-435a-8696-5aace46c1efb","name":"StopRun","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\":{{your-report-id}},\n \"history_id\":{{your-history-id}}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/stop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Fri, 15 Dec 2023 16:37:16 GMT"},{"key":"server","value":"uvicorn"},{"key":"X-Kong-Upstream-Latency","value":"139"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Report run will stop shortly\"\n}"}],"_postman_id":"ce412ec5-8dc5-4bf2-a82e-cd397248c301"},{"name":"History Files","id":"ff788710-051f-4635-808a-d8697de682c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"history_id\":\"{{your-history-id}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/history/files","description":"

List the files of history(run).

\n","urlObject":{"path":["v1","history","files"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"e59c4ecc-dc3c-4e25-ae7e-ddb874e18ee2","name":"History Files","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"history_id\":\"{{your-history-id}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/history/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.8.1"},{"key":"Date","value":"Fri, 15 Dec 2023 16:43:17 GMT"},{"key":"X-Kong-Upstream-Latency","value":"5"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"payload\": [\n {\n \"format\": \"XLSX\",\n \"url\": \"https://your-data-link.com/P6vEFLN\",\n \"expiry\": \"2023-09-19T21:34:32\"\n },\n {\n \"format\": \"XML\",\n \"url\": \"https://your-data-link.com/brv50r7\",\n \"expiry\": \"2023-09-19T21:34:35\"\n },\n {\n \"format\": \"CSV\",\n \"url\": \"https://your-data-link.com/7hshWw8\",\n \"expiry\": \"2023-09-19T21:34:37\"\n }\n ],\n \"message\": \"OK\"\n}"}],"_postman_id":"ff788710-051f-4635-808a-d8697de682c3"},{"name":"ReportRunList","event":[{"listen":"test","script":{"id":"1a2d4bdd-dcb3-47a3-800e-8e4970e3da67","exec":["pm.test(\"Response is ordered by ID\", function () {"," var jsonData = pm.response.json();",""," // Assuming jsonData is an array of objects with an 'id' property"," for (let i = 0; i < jsonData.length - 1; i++) {"," pm.expect(jsonData[i].id).to.be.below(jsonData[i + 1].id);"," }","});",""],"type":"text/javascript"}}],"id":"b55386a3-9481-40f5-b4e4-3fa9e343f80c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\":{{your-report-id}},\n \"size\":5\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/run/list","description":"

List the runs(histories) of report.

\n","urlObject":{"path":["v1","report","run","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"27393d0b-a514-4d18-b25c-92f453a7a356","name":"ReportRunList","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\":{{your-report-id}},\n \"size\":2,\n \"order_by\":\"asc\"//desc\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/run/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"763"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Fri, 15 Dec 2023 16:30:24 GMT"},{"key":"server","value":"uvicorn"},{"key":"X-Kong-Upstream-Latency","value":"400"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": null,\n \"payload\": [\n {\n \"run_id\": {{your-run-id}},\n \"history_id\": {{your-history-id}},\n \"status\": \"COMPLETED\",\n \"run_started\": \"2023-12-15 16:24:18\",\n \"run_ended\": \"2023-12-15 16:24:26\",\n \"files\": [\n {\n \"format\": \"CSV\",\n \"url\": \"https://your-data-link.com/eJw4gf8\",\n \"expiry\": \"2023-12-22T16:24:31\"\n }\n ]\n },\n {\n \"run_id\": {{your-run-id}},\n \"history_id\": {{your-report-id}},\n \"run_params\": {\n \"PaaramName1\": \"Default Value Parameter\",\n \"ParamName2\": \"value1, value 2\",\n \"ParamName10\": \"\"\n },\n \"status\": \"COMPLETED\",\n \"run_started\": \"2023-12-15 15:37:01\",\n \"run_ended\": \"2023-12-15 15:37:04\",\n \"files\": [\n {\n \"format\": \"CSV\",\n \"url\": \"https://your-data-link.com/cRip5Mn\",\n \"expiry\": \"2023-12-22T15:37:40\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"b55386a3-9481-40f5-b4e4-3fa9e343f80c"},{"name":"Search Runs","id":"e9666d1c-740c-4482-951b-2130abec1a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"report_id\": {{your-report-id}},\n \"search_params\":[{\"file_name\": \"2023_12_15_grepsr_test.xlsx\"}] //replace these with your parameters\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/run/search","description":"

Search the runs of the report using custom paramaters.

\n","urlObject":{"path":["v1","report","run","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7eeccae7-9921-4a5a-ac27-e31833f98172","name":"Search Runs","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"report_id\": {{your-report-id}},\n \"search_params\":[{\"file_name\": \"2023_12_15_grepsr_test.xlsx\"}] //replace these with your parameters\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/run/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"324"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Fri, 15 Dec 2023 16:40:21 GMT"},{"key":"server","value":"uvicorn"},{"key":"X-Kong-Upstream-Latency","value":"92"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"historyId\": {{yout-history-id}},\n \"reportId\": {{yout-report-id}},\n \"projectId\": {{yout-project-id}},\n \"status\": \"COMPLETED\",\n \"itemCount\": 23052,\n \"startedDate\": \"2023-12-15 00:16:57\",\n \"endedDate\": \"2023-12-15 00:16:57\",\n \"params\": \"{\\\"file_name\\\": \\\"2023_12_15_grepsr_test.xlsx\\\"}\",\n \"file\": [\n {\n \"url\": \"https://your-data-link.com\",\n \"expiry\": \"2023-12-22 01:09:41\",\n \"format\": \"JSON\"\n }\n ]\n }\n]"}],"_postman_id":"e9666d1c-740c-4482-951b-2130abec1a88"},{"name":"History Run Status","id":"f780ae9d-3a40-4310-b844-2259d4eea5cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"history_id\": {{your-history-id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/history/run/status","description":"

Get the status of runs(histories)

\n","urlObject":{"path":["v1","history","run","status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a31a6661-6b32-46ed-8b65-4d254102a7ea","name":"History Run Status","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"history_id\": {{your-report-id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/history/run/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"83"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.8.1"},{"key":"Date","value":"Fri, 15 Dec 2023 16:37:58 GMT"},{"key":"X-Kong-Upstream-Latency","value":"6"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"payload\": [\n {\n \"run_id\": {{your-run-id}},\n \"status\": \"SUCCESS\"\n }\n ],\n \"message\": \"OK\"\n}"}],"_postman_id":"f780ae9d-3a40-4310-b844-2259d4eea5cd"},{"name":"Report Parameters List","id":"b515f04a-a700-4612-9189-3438cfafff8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{apikey}}","type":"text"}],"url":"{{url}}/v1/report/parameters/list?report_id={{your-report-id}}","description":"

Get the list of parameters for the report

\n","urlObject":{"path":["v1","report","parameters","list"],"host":["{{url}}"],"query":[{"key":"report_id","value":"{{your-report-id}}"}],"variable":[]}},"response":[{"id":"d372e8d1-0c17-470f-b335-0496d01f6b6d","name":"Report Parameters List","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apikey}}","type":"text"}],"url":{"raw":"{{url}}/v1/report/parameters/list?report_id={{your-report-id}}","host":["{{url}}"],"path":["v1","report","parameters","list"],"query":[{"key":"report_id","value":"{{your-report-id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"114"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Fri, 02 Feb 2024 06:42:31 GMT"},{"key":"server","value":"uvicorn"},{"key":"X-Kong-Upstream-Latency","value":"180"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"service_id\": 93969,\n \"parameters\": [\n {\n \"name\": \"limit\",\n \"label\": \"Record Limit\",\n \"description\": \"Dynamic record limit\"\n }\n ]\n }\n]"}],"_postman_id":"b515f04a-a700-4612-9189-3438cfafff8e"},{"name":"Report Schedule Parameters","id":"848ab982-1e34-4e63-8834-de205a3fc14e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apikey}}","type":"text"}],"url":"{{url}}/v1/report/schedule/parameters?report_id={{your-report-id}}&schedule_id={{your-schedule-id}}&scheduler_job_id={{your-schedule-job-id}}","description":"

Get the schedule parameters for the schedule on the report.

Any one of the schedule_id or schedule_job_id could be passed.

\n","urlObject":{"path":["v1","report","schedule","parameters"],"host":["{{url}}"],"query":[{"key":"report_id","value":"{{your-report-id}}"},{"key":"schedule_id","value":"{{your-schedule-id}}"},{"key":"scheduler_job_id","value":"{{your-schedule-job-id}}"}],"variable":[]}},"response":[{"id":"1ef6557e-60e9-4e59-9066-50a1e90040c0","name":"Report Schedule Parameters","originalRequest":{"method":"GET","header":[{"key":"X-API-KEY","value":"{{apikey}}","type":"text"}],"url":{"raw":"{{url}}/v1/report/schedule/parameters?report_id={{your-report-id}}&schedule_id={{your-schedule-id}}&scheduler_job_id={{your-schedule-job-id}}","host":["{{url}}"],"path":["v1","report","schedule","parameters"],"query":[{"key":"report_id","value":"{{your-report-id}}"},{"key":"schedule_id","value":"{{your-schedule-id}}"},{"key":"scheduler_job_id","value":"{{your-schedule-job-id}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"134"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Fri, 02 Feb 2024 06:55:03 GMT"},{"key":"server","value":"uvicorn"},{"key":"X-Kong-Upstream-Latency","value":"161"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"payload\": {\n \"NEwParam\": \"New parameter\",\n \"param2\": \"value1\",\n \"testcheck\": [\n \"world\"\n ],\n \"Testparam\": \"Test Value\"\n },\n \"status\": true,\n \"message\": \"OK\"\n}"}],"_postman_id":"848ab982-1e34-4e63-8834-de205a3fc14e"}],"id":"d20ab443-c368-48cd-ad3f-b8ff1b4516d4","description":"

Project requirements are grouped into disparate sets called Reports. A Report represents a use case, or a granular set of data and delivery requirements that can be executed at once and delivered together.

Each Report is associated with a set of programmatic instructions to source data known as a Crawler (or Service).

\n","_postman_id":"d20ab443-c368-48cd-ad3f-b8ff1b4516d4"},{"name":"Schedules","item":[{"name":"List Schedules","id":"35101a75-8e6d-4b8f-9f73-010334f25c03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"report_id\": {{your-report-id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/schedule/list","description":"

List the schedules for a report.

\n","urlObject":{"path":["v1","report","schedule","list"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"98cea3c2-76c8-4b78-b08e-2092e85d9f2f","name":"List Schedules","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"report_id\": {{your-report-id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/schedule/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"145"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.8.1"},{"key":"Date","value":"Fri, 15 Dec 2023 16:38:32 GMT"},{"key":"X-Kong-Upstream-Latency","value":"8"},{"key":"X-Kong-Proxy-Latency","value":"0"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"payload\": [\n {\n \"schedule_id\": {{your-schedule-id}},\n \"start_date\": 1695631200,\n \"end_date\": null,\n \"next_update\": 1702716000,\n \"parameters\": []\n }\n ],\n \"message\": \"OK\"\n}"}],"_postman_id":"35101a75-8e6d-4b8f-9f73-010334f25c03"},{"name":"Stop Schedule","id":"03a70a30-bb94-4181-9865-f59563b2125f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schedule_id\":{{your-schedule-id}},\n \"report_id\":{{your-report-id}},\n \"delete\":{{true-or-false}}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/schedule/stop","description":"

Stop the current schedule for a report.

\n","urlObject":{"path":["v1","report","schedule","stop"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"956010f7-a61c-4b44-a9e2-d0c70defdc72","name":"Stop Schedule","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schedule_id\":{{your-schedule-id}},\n \"report_id\":{{your-report-id}},\n \"delete\":{{true-or-false}}\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/schedule/stop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"81"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/19.8.1"},{"key":"Date","value":"Thu, 04 Jan 2024 09:13:35 GMT"},{"key":"X-Kong-Upstream-Latency","value":"256"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"payload\": {\n \"next_update\": 1703254080\n },\n \"message\": \"Schedule stopped\"\n}"}],"_postman_id":"03a70a30-bb94-4181-9865-f59563b2125f"}],"id":"29db138e-7c7f-4abf-8d0f-ed29342b0acf","description":"

Schedule is a plan for running a report on specific date/time.

\n","_postman_id":"29db138e-7c7f-4abf-8d0f-ed29342b0acf"},{"name":"Feed","item":[{"name":"GetFeed(Default Format)","id":"1a1483bd-3006-4a99-8975-a443eadd32b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://feed.grepsr.com/v1/files/{{report_uuid}}/{{feed_type}}","description":"

This is the response in default format of the run of the crawler.

\n","urlObject":{"protocol":"https","path":["v1","files","{{report_uuid}}","{{feed_type}}"],"host":["feed","grepsr","com"],"query":[],"variable":[]}},"response":[{"id":"8efffefb-9081-476e-983a-e42878efe59b","name":"GetFeed(Default Format)","originalRequest":{"method":"GET","header":[],"url":"https://feed.grepsr.com/v1/files/{{report_uuid}}/{{feed_type}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-amz-id-2","value":"Nf1tNQZnzIRYYhd3cxleWGXI43y4vOn3oXHyZqkHFPXcESVyb80DMfzeTio2Qx3YIwQ1qtMzvJA="},{"key":"x-amz-request-id","value":"7WK4J037VSYNVX3E"},{"key":"Date","value":"Thu, 04 Jan 2024 11:10:26 GMT"},{"key":"Last-Modified","value":"Thu, 04 Jan 2024 10:45:43 GMT"},{"key":"ETag","value":"\"2662d5945b8443e804344f4e113adac7\""},{"key":"x-amz-storage-class","value":"ONEZONE_IA"},{"key":"x-amz-server-side-encryption","value":"AES256"},{"key":"Content-Disposition","value":"attachment; filename=\"Online_Khabar_News.json\""},{"key":"Accept-Ranges","value":"bytes"},{"key":"Content-Type","value":"application/json"},{"key":"Server","value":"AmazonS3"},{"key":"Content-Length","value":"303"}],"cookie":[],"responseTime":null,"body":"{\n \"Title\": \"Your Data Title\",\n \"Image\": \"https://your-image-link.com/grepsr.jpg\",\n \"Link\": \"https://crawled-website.com/blog/HowToCrawlData\"\n}"}],"_postman_id":"1a1483bd-3006-4a99-8975-a443eadd32b0"},{"name":"GetFeed(Custom Feed)","id":"83b9025b-b1c4-410e-9fda-f04fde008d6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://feed.grepsr.com/v1/files/{{report_uuid}}/{{feed_type}}/{{feed_format}}","description":"

This is the response in selected format of the run of the crawler.

\n","urlObject":{"protocol":"https","path":["v1","files","{{report_uuid}}","{{feed_type}}","{{feed_format}}"],"host":["feed","grepsr","com"],"query":[],"variable":[]}},"response":[{"id":"507ef7bb-cca5-45f9-97b9-88cd99c49331","name":"GetFeed(Custom Feed)","originalRequest":{"method":"GET","header":[],"url":"https://feed.grepsr.com/v1/files/{{report_uuid}}/{{feed_type}}/{{feed_format}}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"x-amz-id-2","value":"IyJYxDWIsHt6yRYhLL8rs7++0evRdj8NKc2smqPKac3H6MjG1rVvjCBixQKM4TFoqQCWBhd7WZU="},{"key":"x-amz-request-id","value":"JXCCNJHFT6RZJ91E"},{"key":"Date","value":"Thu, 04 Jan 2024 11:12:47 GMT"},{"key":"Last-Modified","value":"Thu, 04 Jan 2024 10:45:31 GMT"},{"key":"ETag","value":"\"9b681ce78c740169de31b480bbc8e4d6\""},{"key":"x-amz-storage-class","value":"ONEZONE_IA"},{"key":"x-amz-server-side-encryption","value":"AES256"},{"key":"Content-Disposition","value":"attachment; filename=\"202401041045-Online_Khabar_News.csv\""},{"key":"Accept-Ranges","value":"bytes"},{"key":"Content-Type","value":"text/csv"},{"key":"Server","value":"AmazonS3"},{"key":"Content-Length","value":"286"}],"cookie":[],"responseTime":null,"body":"Title,Image,Link\r\nCrawled Website Title,https://crawled-website-image.com,https://crawled-website.com/blog/HowToCrawlData.html\r\n"}],"_postman_id":"83b9025b-b1c4-410e-9fda-f04fde008d6b"}],"id":"4c624016-b672-4848-a4f3-8ca0bd36cd8b","description":"

This is the response of the run of the crawler.

\n","_postman_id":"4c624016-b672-4848-a4f3-8ca0bd36cd8b"},{"name":"Instant Crawler API","item":[{"name":"Run Instant Crawler","id":"80a699e0-846b-49b4-8cc5-d0bed5494eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"

Get your API Key from your Profile.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"param1\":\"hello\",\n \"param2\": \"world\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/{{report_id}}/run/crawler","description":"

Run an instant crawler and get the data on response.

\n","urlObject":{"path":["v1","report","{{report_id}}","run","crawler"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"3db89126-f145-4093-ac0a-6af3cba182d6","name":"Run Instant Crawler","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{apikey}}","description":"Get your API Key from your Profile.","type":"text"}],"body":{"mode":"raw","raw":"{\n \"param1\":\"hello\",\n \"param2\": \"world\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/report/{{report_id}}/run/crawler"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"142"},{"key":"Connection","value":"keep-alive"},{"key":"date","value":"Wed, 29 Oct 2025 07:01:23 GMT"},{"key":"server","value":"uvicorn"},{"key":"kong_request_id","value":"0ac25d23-22fd-43c8-af91-ebee88dd523d"},{"key":"x-crawler-size","value":"41710"},{"key":"x-crawler-requests","value":"1"},{"key":"x-crawler-runtime","value":"1"},{"key":"X-Kong-Upstream-Latency","value":"787"},{"key":"X-Kong-Proxy-Latency","value":"1"},{"key":"Via","value":"kong/2.8.3"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Crawler run complete\",\n \"payload\": {\n \"status\": true,\n \"title\": \"Apple\"\n },\n \"request_id\": \"0ac25d23-22fd-43c8-af91-ebee88dd523d\"\n}"}],"_postman_id":"80a699e0-846b-49b4-8cc5-d0bed5494eac"}],"id":"fd969aa7-cfd5-4345-aa93-136eb154dffc","description":"

Instant Crawler API delivers web data directly in the API response, eliminating wait times for immediate application needs.

\n","_postman_id":"fd969aa7-cfd5-4345-aa93-136eb154dffc"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"de84c8ad-1d09-4912-ac33-d47a12094a03"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"29a864ac-7fe9-4150-990a-790e7de160bc"}}]}