Runs

Get the session log

The settled record of a migration: what was planned, which files went in, who approved what, how many rows were written, and whether existing rows were replaced.

Intended to be fetched once and stored, so you can explain a migration to your own customer later. It does not include the conversation transcript — that is /thread — and it does not include individual row values.

Available once nothing is in flight, including for migrations that failed: a run can write rows and then fail, which is exactly when this matters. While a run is active the endpoint returns 409.

Pass ?format=md for the same record as a readable Markdown report.

A migration can be imported again later, so the log always covers every run to date — a re-fetch is a superset of an earlier one. Use generated_at to tell snapshots apart.

GET

migrations

{migration_id}

log

Get the session log

curl --request GET \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/log \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.vern.so/api/v1/migrations/{migration_id}/log', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vern.so/api/v1/migrations/{migration_id}/log",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vern.so/api/v1/migrations/{migration_id}/log"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.vern.so/api/v1/migrations/{migration_id}/log")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "migration_id": "<string>",
  "generated_at": "<string>",
  "covers": {
    "runs": 123,
    "from": "<string>",
    "to": "<string>"
  },
  "runs": [
    {
      "run_id": "<string>",
      "kind": "<string>",
      "status": "<string>",
      "started_at": "<string>",
      "completed_at": "<string>",
      "started_by": "<string>",
      "files": [
        "<string>"
      ],
      "plan": "<string>",
      "questions": [
        {}
      ],
      "answers": {},
      "outcome": {
        "ok": true,
        "rows_written": 123,
        "per_sheet": [
          {
            "sheet": "<string>",
            "rows": 123
          }
        ],
        "invalid_rows": 123,
        "error": "<string>",
        "replaced_existing_data": true
      },
      "audit": [
        {
          "at": "<string>",
          "actor": "<string>",
          "mode": "<string>",
          "answers_excerpt": "<string>",
          "changes": [
            {}
          ],
          "plan": "<string>"
        }
      ]
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "retry_after_seconds": 30
}

{
  "error": "Too many requests"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Your Vern API key. Create one at Settings → API keys.

Path Parameters

migration_id

string<uuid>

required

The migration ID returned by Create a migration.

Query Parameters

format

enum<string>

default:json

Available options:

json,

md,

markdown

Response

The session log.

migration_id

string

generated_at

string

status

enum<string>

awaiting_files — no files uploaded and no source connection
ready — inputs present, no plan yet
awaiting_approval — a preview is waiting to be executed
completed — an import has run successfully

Available options:

awaiting_files,

ready,

awaiting_approval,

completed

covers

object

Show child attributes

runs

object[]

Show child attributes

Get the session log

curl --request GET \
  --url https://app.vern.so/api/v1/migrations/{migration_id}/log \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.vern.so/api/v1/migrations/{migration_id}/log', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.vern.so/api/v1/migrations/{migration_id}/log",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.vern.so/api/v1/migrations/{migration_id}/log"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.vern.so/api/v1/migrations/{migration_id}/log")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "migration_id": "<string>",
  "generated_at": "<string>",
  "covers": {
    "runs": 123,
    "from": "<string>",
    "to": "<string>"
  },
  "runs": [
    {
      "run_id": "<string>",
      "kind": "<string>",
      "status": "<string>",
      "started_at": "<string>",
      "completed_at": "<string>",
      "started_by": "<string>",
      "files": [
        "<string>"
      ],
      "plan": "<string>",
      "questions": [
        {}
      ],
      "answers": {},
      "outcome": {
        "ok": true,
        "rows_written": 123,
        "per_sheet": [
          {
            "sheet": "<string>",
            "rows": 123
          }
        ],
        "invalid_rows": 123,
        "error": "<string>",
        "replaced_existing_data": true
      },
      "audit": [
        {
          "at": "<string>",
          "actor": "<string>",
          "mode": "<string>",
          "answers_excerpt": "<string>",
          "changes": [
            {}
          ],
          "plan": "<string>"
        }
      ]
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>",
  "retry_after_seconds": 30
}

{
  "error": "Too many requests"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Overview

Catalog

Migrations

Runs

Export

Documents

Get the session log

Authorizations

Path Parameters

Query Parameters

Response