Grepsr APIs

Grepsr is a managed web data extraction platform whose REST API lets you trigger, manage, and retrieve results from web scraping jobs. Using this connector, you can list projects and reports, run or stop crawlers, inspect run histories and their files, and pull the extracted feed data directly into Nexla.

Power end-to-end data operations for your Grepsr APIs API with Nexla. Our bi-directional Grepsr APIs connector is purpose-built for Grepsr APIs, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Grepsr APIs or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Grepsr APIs workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Grepsr credential, you need an active Grepsr account and an API key issued for that account. The Grepsr API authenticates every request with an API key, which is sent in the X-Api-Key request header.

To obtain your Grepsr API key, follow these steps:

1. Sign in to the Grepsr platform at platform.grepsr.com using your account credentials.

2. Open your account or API settings to locate the API key issued for your account. If an API key is not already available, generate one or contact your Grepsr account manager to have API access enabled.

3. Copy the API key value and store it securely, as it grants programmatic access to your Grepsr projects, reports, and scraped data.

The API key is sent in the X-Api-Key header on every request to authenticate against your Grepsr account. Treat the key as sensitive information; if it is compromised, rotate or revoke it from within the Grepsr platform. For details on the available operations and request parameters, refer to the Grepsr API Documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes	An encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla

1. After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Grepsr API key in the API Key Value field. This value is sent in the X-Api-Key header for all API requests to the Grepsr API and must be kept confidential.

   If your API key is compromised, rotate or revoke it from within the Grepsr platform and update your Nexla credential with the new value. The API key provides access to your Grepsr projects and scraped data and should be treated as sensitive information.

   For detailed information about Grepsr API authentication and available endpoints, see the Grepsr API Documentation.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Grepsr APIs connector tile, then select the credential that will be used to connect to Grepsr, and click Next; or, create a new Grepsr credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Grepsr endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Projects

Get a list of all your projects.

[Rest API] ListHistories

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

[Rest API] Run Report

Run the report (crawler) to scrape data. You can later retrieve the data at the delivery destination you have configured on the Grepsr platform.

[Rest API] StopRun

Stop the running report (crawler) by terminating all of its processes and jobs.

[Rest API] History Files

List the files of a history (run).

[Rest API] ReportRunList

List the runs (histories) of a report.

[Rest API] Search Runs

Search the runs of the report using custom parameters.

[Rest API] History Run Status

Get the status of runs (histories).

[Rest API] Report Parameters List

Get the list of parameters for the report.

[Rest API] Report Schedule Parameters

Get the schedule parameters for the schedule on the report. Either the schedule_id or the schedule_job_id can be passed.

[Rest API] List Schedules

List the schedules for a report.

[Rest API] Stop Schedule

Stop the current schedule for a report.

[Rest API] GetFeed (Default Format)

Retrieve the response in the default format from the run of the crawler.

[Rest API] GetFeed (Custom Feed)

Retrieve the response in a selected format from the run of the crawler.

[Rest API] Run Instant Crawler

Run an instant crawler and get the scraped data in the response.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Grepsr data sources can also be manually configured to ingest data from any valid Grepsr API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Grepsr data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.