Get Data Snippet

get

https://backend.segna.io/public/client-side/v1/data-snippet/{jobId}

Get a snippet of the data. You can specify what step of the data (e.g. before cleaning, after cleaning), as well as the number of rows.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

jobId

string

required

The id of a Job

Query Params

nRows

string

The number of rows to return. This argument is optional, and if unspecified, will return 10 rows. You can also specify all to return all rows.

dataVersion

string

enum

The name of the data version from which to retrieve the data snippet. This argument is optional and if unspecified will fetch the fields step.

Allowed:

afterChanges

string

enum

Specify whether to get the data snippet before or after the change made in the specified data version step. This argument is optional and if unspecified will use the pre-edited data version.

Allowed:

sheetName

string

The name of the sheet from which to retrieve the data snippet. This argument is optional and if unspecified will use the first sheet in the workbook. This argument is only applicable if the data version is sheet_selection.

offset

string

The number of rows to skip/offset when returning the data snippet. This argument is optional and if unspecified will not skip any rows.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200success