Preview the rows of a query of the mapping

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "binding": "contract: br.example.document\nqueries: []\n",
  "query": "saldos",
  "limit": 20,
  "parameters": {}
}
'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview"

	payload := strings.NewReader("{\n  \"binding\": \"contract: br.example.document\\nqueries: []\\n\",\n  \"query\": \"saldos\",\n  \"limit\": 20,\n  \"parameters\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    binding: 'contract: br.example.document\nqueries: []\n',
    query: 'saldos',
    limit: 20,
    parameters: {}
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview"

payload = {
    "binding": "contract: br.example.document
queries: []
",
    "query": "saldos",
    "limit": 20,
    "parameters": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "columns": [
    "cosif",
    "natureza",
    "saldo"
  ],
  "durationMs": 41,
  "hasMore": false,
  "limit": 20,
  "query": "saldos",
  "rows": [
    {}
  ]
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Preview the rows of a query of the mapping

Reads the first rows ONE query of a mapping returns — the mapping as sent, saved or not, and never saved by this call — exactly as a generation reads it: planned against the subscription’s pinned contract, with its filters (a parameter edge cut by the contract’s calendar), joins, computed columns, aggregation and closed-set narrowing, scoped to the institution the subscription files for. The closed-period rule does not apply, so the current period can be previewed. At most limit rows (1 to 100, default 20) are answered; hasMore says the query has more. A query that reads another query’s rows, a construct the engine does not execute, and the CRM source are refused. Previews share PREVIEW_MAX_CONCURRENT slots and answer 429 when they are busy. The body is capped at 1048576 bytes.

POST

regulatory

subscriptions

{subscriptionId}

binding

preview

Preview the rows of a query of the mapping

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "binding": "contract: br.example.document\nqueries: []\n",
  "query": "saldos",
  "limit": 20,
  "parameters": {}
}
'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview"

	payload := strings.NewReader("{\n  \"binding\": \"contract: br.example.document\\nqueries: []\\n\",\n  \"query\": \"saldos\",\n  \"limit\": 20,\n  \"parameters\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    binding: 'contract: br.example.document\nqueries: []\n',
    query: 'saldos',
    limit: 20,
    parameters: {}
  })
};

fetch('https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/regulatory/subscriptions/{subscriptionId}/binding/preview"

payload = {
    "binding": "contract: br.example.document
queries: []
",
    "query": "saldos",
    "limit": 20,
    "parameters": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "columns": [
    "cosif",
    "natureza",
    "saldo"
  ],
  "durationMs": 41,
  "hasMore": false,
  "limit": 20,
  "query": "saldos",
  "rows": [
    {}
  ]
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

subscriptionId

string

required

Unique subscription identifier.

Body

application/json

binding

string

required

The whole mapping, as YAML, exactly as a save would send it. It is planned against the subscription's pinned contract and NEVER saved.

Example:

"contract: br.example.document\nqueries: []\n"

query

string

required

The query of the mapping to read.

Example:

"saldos"

limit

integer<int64>

How many rows to answer, 1 to 100. Absent: 20.

Example:

20

parameters

object

Generation parameters the query's filters read, as a generation would be given them. Only the ones supplied are validated; the closed-period rule does not apply to a preview.

Show child attributes

Response

columns

string[] | null

required

The columns the query answers, in order: its groups then its sums when it aggregates; the columns it selects, else the ones it reads, when it does not.

Example:

["cosif", "natureza", "saldo"]

durationMs

integer<int64>

required

How long the read took.

Example:

41

hasMore

boolean

required

True when the query has more rows than the limit; the rows were cut, never refused.

Example:

false

limit

integer<int64>

required

The limit applied.

Example:

20

query

string

required

The query read.

Example:

"saldos"

rows

object[] | null

required

At most limit rows, each keyed by the columns above. A number is its decimal text, never a float; null is null.

Show child attributes

Getting started

Templates API

Template Builder API

Reports API

Deadlines API

Data Sources API

Institutions API

Regulatory Catalog API

Regulatory Subscriptions API

Regulatory Bindings API

Regulatory Reports API

Metrics API

Streaming API

Error handling

Events

Preview the rows of a query of the mapping

Authorizations

Path Parameters

Body

Response