Skip to main content
GET
/
v1
/
analyses
List analyses
curl --request GET \
  --url https://api.passu.ai/v1/analyses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scope": {
        "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "scope_type": "EVENT"
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "sections": [
        {
          "sentences": [
            {
              "text": "<string>",
              "quotes": [
                {
                  "text": "<string>",
                  "author": "<string>",
                  "title": "<string>",
                  "table_name": "<string>",
                  "row_names": [
                    "<string>"
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
event_id
string<uuid> | null

Filter analyses by event id.

​
company_id
string<uuid> | null

Filter analyses by company id.

​
sector_id
string<uuid> | null

Filter analyses by sector id.

​
analysis_type
enum<string> | null

Filter analyses by type. Public analysis-type enum mirroring the hierarchy level.

Event sub-kind (earnings / conference / news) is derivable from the linked corporate event and deliberately not reflected here.

Available options:
EVENT,
COMPANY_QUARTERLY,
SECTOR_QUARTERLY
​
cursor
string | null

Opaque cursor for pagination.

​
limit
integer
default:50

Maximum number of records to return.

Required range: 1 <= x <= 200

Response

Successful Response

​
data
Analysis · object[]
required
​
has_more
boolean
required
​
next_cursor
string | null