Deck Data

GET

/api/v1/group/:group_id/deal/:deal_id/data/deck

GET

/api/v1/group/:group_id/deal/:deal_id/data/deck

$ curl https://app.termina.ai/api/v1/group/1/deal/1/data/deck \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "file_id": 42,
4     "file_name": "acme-deck.pdf",
5     "gcs_uri": "string",
6     "num_pages": 18,
7     "logic_name": "parse_deck",
8     "logic_version": "0.1",
9     "metadata": {
10       "filename": "string",
11       "uri": "string",
12       "file_type": "string",
13       "author": "string",
14       "created_at": "string",
15       "last_updated_at": "string",
16       "source_system": "string"
17     },
18     "pages": [
19       {
20         "page_number": 1,
21         "title": "string",
22         "description": "string",
23         "raw_text": "string",
24         "general_context": [
25           "string"
26         ],
27         "data_series": [
28           {
29             "metrics": [
30               {
31                 "metric": "string",
32                 "normalized_metric": "string",
33                 "dtype": "string"
34               }
35             ],
36             "series_type": "temporal",
37             "description": "string",
38             "points": [
39               {
40                 "values": [
41                   {
42                     "metric": "string",
43                     "normalized_metric": "string",
44                     "value": 1,
45                     "dtype": "string"
46                   }
47                 ],
48                 "forecast": false,
49                 "temporal": {
50                   "type": "point",
51                   "raw": "string",
52                   "start_date": "string",
53                   "end_date": "string",
54                   "grain": "string"
55                 }
56               }
57             ],
58             "context": [
59               "string"
60             ]
61           }
62         ],
63         "data_points": [
64           {
65             "values": [
66               {
67                 "metric": "string",
68                 "normalized_metric": "string",
69                 "value": 1,
70                 "dtype": "string"
71               }
72             ],
73             "forecast": false,
74             "temporal": {
75               "type": "point",
76               "raw": "string",
77               "start_date": "string",
78               "end_date": "string",
79               "grain": "string"
80             }
81           }
82         ]
83       }
84     ],
85     "summary": {
86       "title": "",
87       "summary": ""
88     }
89   }
90 ]

Get parsed deck data for every deck file attached to the deal.

Returns an empty list when no decks have been parsed/published.

Authentication

AuthorizationBearer

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

Path parameters

group_idintegerRequired

deal_idintegerRequired

Response

Successful Response

file_idinteger

ID of the source deck file on the deal.

file_namestring

Name of the source deck PDF.

gcs_uristring

GCS URI of the source deck PDF.

num_pagesinteger

Number of pages parsed from the deck.

logic_namestring

Parsing logic identifier.

logic_versionstring

Parsing logic version.

metadataobjectOptional

pageslist of objectsOptional

Per-page data-centric content.

summaryobject or nullOptional

Best-effort deck summary; may be null.

Errors

422

Unprocessable Entity Error