By Ids

GET

https://api.hellodata.ai/property_report/by_ids

GET

/property_report/by_ids

1 import requests
2 
3 url = "https://api.hellodata.ai/property_report/by_ids"
4 
5 querystring = {"ids":"ids"}
6 
7 payload = {}
8 headers = {
9     "x-api-key": "<apiKey>",
10     "Content-Type": "application/json"
11 }
12 
13 response = requests.get(url, json=payload, headers=headers, params=querystring)
14 
15 print(response.json())

200Retrieved

1 {
2   "data": [
3     {
4       "id": 101.5,
5       "name": "Downtown Office Market Report Q1 2024",
6       "subject": {
7         "id": "52907745-7672-470e-a803-a2f8feb52944",
8         "building_name": "The Main Building",
9         "building_name_alias": [
10           "The Main Building",
11           "Main Building",
12           "Main"
13         ],
14         "street_address": "123 Main St",
15         "street_address_alias": [
16           "123 Main St",
17           "125 Main Street"
18         ],
19         "city": "San Francisco",
20         "state": "CA",
21         "zip_code": "94103",
22         "id_alias": [
23           "52907745-7672-470e-a803-a2f8feb52944"
24         ],
25         "lat": 40.7128,
26         "lon": -74.006,
27         "number_units": 314,
28         "year_built": 2020,
29         "number_stories": 60,
30         "created_on": "2023-11-01"
31       },
32       "comparable_addresses": [
33         {
34           "id": "a3f1c9d2-8b4e-4f7a-9c2d-1e2f3a4b5c6d",
35           "building_name": "Riverside Plaza",
36           "building_name_alias": [
37             "Riverside Plaza",
38             "Riverside",
39             "The Plaza"
40           ],
41           "street_address": "200 Riverside Dr",
42           "street_address_alias": [
43             "200 Riverside Dr",
44             "202 Riverside Drive"
45           ],
46           "city": "San Francisco",
47           "state": "CA",
48           "zip_code": "94103",
49           "id_alias": [
50             "a3f1c9d2-8b4e-4f7a-9c2d-1e2f3a4b5c6d"
51           ],
52           "lat": 40.7135,
53           "lon": -74.007,
54           "number_units": 280,
55           "year_built": 2018,
56           "number_stories": 55,
57           "created_on": "2023-10-15"
58         }
59       ],
60       "excluded_property_ids": [
61         "7f9c2d1e-3a4b-5c6d-a3f1-c9d28b4e4f7a"
62       ],
63       "user_id": "user_7890",
64       "modified_on": "2024-04-10T14:45:00Z",
65       "created_on": "2023-12-01T08:00:00Z",
66       "is_organization_visible": true,
67       "tags": [
68         "Q1",
69         "Downtown",
70         "Office"
71       ],
72       "view_preferences": [
73         {
74           "name": "the_grid",
75           "building_rows": [
76             "property_grid.address",
77             "property_grid.number_units",
78             "property_grid.year_built"
79           ],
80           "unit_rows": [
81             "unit_details.floorplan_name",
82             "unit_details.rent_psf"
83           ]
84         }
85       ],
86       "email_schedule": {
87         "emails": [
88           "report.recipient@company.com",
89           "manager@company.com"
90         ],
91         "cron_expression": "0 9 1 * *",
92         "id": 202,
93         "schedulable_id": 101.5,
94         "schedulable_type": "property_reports",
95         "last_execution": "2024-04-01T09:00:00Z",
96         "next_execution": "2024-05-01T09:00:00Z",
97         "created_on": "2023-12-01T08:00:00Z",
98         "modified_on": "2024-03-01T08:00:00Z"
99       },
100       "public_id": "pub-2024-downtown-q1",
101       "feature_flags": [
102         "make_organization_visible",
103         "member_external_sharing"
104       ],
105       "property_edits": [
106         {
107           "report_id": 101.5,
108           "user_id": "user_7890",
109           "property_id": "52907745-7672-470e-a803-a2f8feb52944",
110           "year_built": 2020,
111           "number_stories": 60,
112           "number_units": 314,
113           "building_amenities": [
114             "24_hour_maintenance",
115             "fitness_center",
116             "parking_garage"
117           ],
118           "unit_amenities": [
119             "air_conditioning",
120             "dishwasher",
121             "hardwood_floor"
122           ],
123           "building_name": "The Main Building Renovated",
124           "cats_monthly_rent": 75,
125           "cats_one_time_fee": 150,
126           "cats_deposit": 200,
127           "dogs_monthly_rent": 75,
128           "dogs_one_time_fee": 150,
129           "dogs_deposit": 200,
130           "admin_fee": 600,
131           "application_fee": 75,
132           "storage_fee": 60,
133           "parking_covered": 320,
134           "parking_garage": 350,
135           "parking_surface_lot": 120,
136           "street_address": "123 Main St",
137           "management_company": "The Bozzuto Group",
138           "building_website": "https://www.themainbuilding.com",
139           "street_view_url": "https://www.themainbuilding.com/images/streetview.jpg",
140           "is_student": false,
141           "is_senior": false,
142           "is_build_to_rent": false,
143           "is_affordable": false,
144           "is_lease_up": false,
145           "fees": [
146             {
147               "label": "Trash Service",
148               "amount": 25,
149               "frequency": "month"
150             }
151           ]
152         }
153       ],
154       "access_users": [
155         {
156           "id": "user_1234",
157           "given_name": "Alice",
158           "family_name": "Johnson",
159           "picture": "https://company.com/profiles/alice.jpg",
160           "email": "alice.johnson@company.com",
161           "read_only": true,
162           "job_title": "Analyst / Data"
163         },
164         {
165           "id": "user_5678",
166           "given_name": "Bob",
167           "family_name": "Smith",
168           "picture": "https://company.com/profiles/bob.jpg",
169           "email": "bob.smith@company.com",
170           "read_only": false,
171           "job_title": "Property Operations"
172         }
173       ],
174       "sections": [
175         "property_grid",
176         "amenities",
177         "financial_analysis"
178       ],
179       "columns": [
180         "property_grid.similarity",
181         "property_grid.year_built",
182         "amenities.rent_psf"
183       ],
184       "metadata": {
185         "region": "West Coast",
186         "report_type": "Quarterly"
187       },
188       "is_in_portfolio": true,
189       "organization_visibility": "editor"
190     }
191   ]
192 }

Fetch multiple reports by IDs in a single call (used by bulk-assign mini table) Example: /property_report/by_ids?ids=1,2,3

Authentication

x-api-keystring

API Key authentication via header

AuthorizationBearer

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

Query parameters

idsstringRequired

A comma-separated list of report IDs to fetch

Response

datalist of objects

metaany or null