Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

reports

Search and list embedded report rows

post/app/v3/reports/{report_id}/embedded/search

Path parameters

report_idstring uuid required

Report ID

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_bystring
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "header_name.value",
  "sort_direction": "desc"
}

Response

List of embedded report rows

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "cells": {
        "header_a": {
          "value": "1",
          "style": "success"
        },
        "header_b": {
          "value": "2",
          "style": "error"
        }
      }
    }
  ]
}