v1

latestOpenAPI 3.0.0Apache 2.02026-07-24112122.9 KB
Export API

Get Intersections Values

Returns intersection values from a data model that match all the given filters (if any), in either JSON or CSV format. The following parameters let you specify the data model you'd like to retrieve intersection values from, the format of the response, the max number of the intersections to return, an afterKey used for paginating large datasets, and a filter object to specify the Vena members you'd like to retrieve data from.

get/models/{modelId}/intersections

Path parameters

modelIdstring required
Example:123456789012345678

ID of the data model

Query parameters

filtersstring
Example:[{"field":"Year","eq":"2023"}]

List of filters to restrict the result set

pageSizeinteger

Number of records to return per page, the maximum value is 100000

afterKeystring
Example:ABCDEFG12345678

Pagination parameter key

Headers

Accept'application/json' | 'text/csv' | '*/*'

Response media type

Response

successfully processed intersection request

Example response

{
  "data": [
    [
      "Account",
      "Entity",
      "Department",
      "Placeholder 1",
      "Placeholder 2",
      "Placeholder 3",
      "Placeholder 4",
      "Year",
      "Period",
      "Scenario",
      "Currency",
      "Measure",
      "Value"
    ],
    [
      "3910",
      "V001",
      "D10",
      "Undefined",
      "Undefined",
      "Undefined",
      "Undefined",
      "2019",
      "1",
      "Actual",
      "Local",
      "Value",
      "2511.71"
    ],
    [
      "3910",
      "V001",
      "D10",
      "Undefined",
      "Undefined",
      "Undefined",
      "Undefined",
      "2019",
      "2",
      "Actual",
      "Local",
      "Value",
      "2511.71"
    ],
    [
      "3910",
      "V001",
      "D10",
      "Undefined",
      "Undefined",
      "Undefined",
      "Undefined",
      "2019",
      "3",
      "Actual",
      "Local",
      "Value",
      "2511.71"
    ]
  ],
  "metadata": {
    "headers": [
      "Account",
      "Entity",
      "Department",
      "Placeholder 1",
      "Placeholder 2",
      "Placeholder 3",
      "Placeholder 4",
      "Year",
      "Period",
      "Scenario",
      "Currency",
      "Measure",
      "Value"
    ],
    "recordsReturned": 2,
    "nextPage": "https://us1.vena.io/api/public/v1/models/123456789012345678/intersections?afterKey=ABCDEFG12345678"
  }
}