Skip to content

Commit a1565c0

Browse files
author
Keegan Cordeiro
committed
add docs and update readme
1 parent b1af846 commit a1565c0

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ If you are migrating to version 3.0.0 or above from an earlier version, please c
2929

3030
If you are migrating to version 4.0.0 or above from an earlier version, please check the [V4 breaking changes details](./docs/V4_Breaking_Changes.md).
3131

32+
If you are migrating to version 5.0.0 or above from an earlier version, please check the [V5 breaking changes details](./docs/V5_Breaking_Changes.md).
33+
3234
## Usage
3335

3436
We support all the endpoints available in our API.

docs/V5_Breaking_Changes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# V5 breaking changes details
2+
3+
V5 removes the following fields from the Beam correlation results response;
4+
* features
5+
* phq_impact_sum
6+
* phq_spend_sum
7+
* phq_attendance_sum
8+
* phq_rank_count
9+
10+
It is recommended to query features directly from [Features API](https://docs.predicthq.com/api/features/get-features)

0 commit comments

Comments
 (0)