ONoneschema
Importer Embeds

Get imported rows for an embed file

Retrieve validated data from an embed file with optional pagination.

get/v1/embeds/{embed_id}/imported-rows

Request

  • Base URL
    https://api.oneschema.co
  • URL
    https://api.oneschema.co/v1/embeds/{embed_id}/imported-rows
  • Auth
    API key in header X-API-KEY

Path parameters

embed_idinteger required

The id of the embed which contains the file.

Query parameters

start_rowinteger

The (0-based) row index of the first row to include.

countinteger

The number of rows to retrieve (default is all rows).

Response

200

template_keystring
workspace_idinteger
workspace_metadataEmptyResponse
studio_project_metadataStudioProjectMetadata

A JSON object containing any custom metadata associated with the originating project, if the export originated from a project that has custom metadata configured.

studio_folder_metadataStudioFolderMetadata

Merged custom metadata of the Studio folders containing the project, from the root folder down; keys set on a child folder override the same keys on its parent folders. Omitted when empty.

studio_metadataStudioMetadata

Merged custom metadata of the Studio folders containing the project and the project's own custom metadata, with project keys taking precedence. Omitted when empty. Only sent when the corresponding feature flag is enabled for your org.

sheet_idinteger
countinteger
error_recordsEmptyResponse[]

Example response

{
  "template_key": "contacts",
  "workspace_id": 313174,
  "sheet_id": 88914,
  "sheet_metadata": {
    "original_file_name": "original-file.csv"
  },
  "columns": [
    {
      "sheet_column_name": "First Name",
      "template_column_name": "First Name",
      "template_column_key": "first_name"
    }
  ],
  "count": 995,
  "records": [
    {
      "account_name": "Box",
      "first_name": "Aditi",
      "last_name": "Goel",
      "owner": "Akshay Goel",
      "lead_source": "website",
      "date_added": "11/15/2020",
      "country_code": "US",
      "mailing_address": "925 N Rossiter Blvd, Mount Dora, FL, 32757",
      "timezone": "America/New_York",
      "market_segment": "SMB",
      "title": "Information Systems Manager",
      "email_opt_out": "FALSE",
      "average_spend": "$7,937.18"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.