Reports

Get Report Data by Report Id.

get

Authorizations

Path parameters

idstring · uuidrequired

Query parameters

SortDirectionall ofoptional

parameter to sort data ascending or descending. Default is descending.

SortByFieldstringoptional

Parameter of what field to sort by. the parameter string is case insensitive and should match the reports field name.

Example: accountNumber

PageSizeinteger · int32optional

Page Size

Example: 20

PageNumberinteger · int32optional

Page Number

Example: 1

Header parameters

api-versionstringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sandbox.younium.com/Reports/{id}/Data'

200

400

401

403

200

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Success

Get Reports

get

Authorizations

Query parameters

Filterstringoptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystringoptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-timeoptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 03/01/2025 00:00:00

ModifiedBeforestring · date-timeoptional

Apply a separate filter to only get records that has been modified Before the specified date time.

Example: 03/01/2025 00:00:00

PageSizeinteger · int32optional

Page Size

Example: 20

PageNumberinteger · int32optional

Page Number

Example: 1

Header parameters

api-versionstringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sandbox.younium.com/Reports'

200

400

401

403

200

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "entityName": "text",
      "fields": [
        "text"
      ]
    }
  ]
}

Success

Get Reports by Id

get

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstringoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sandbox.younium.com/Reports/{id}'

200

400

401

403

404

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "entityName": "text",
  "fields": [
    "text"
  ]
}

Success

---