|
5 | 5 | url: https://app.linkbreakers.com |
6 | 6 | description: This is a documentation of all the APIs of Linkbreakers |
7 | 7 | title: Linkbreakers API |
8 | | - version: 1.107.2 |
| 8 | + version: 1.107.3 |
9 | 9 | servers: |
10 | 10 | - url: https://api.linkbreakers.com |
11 | 11 | security: |
@@ -4187,6 +4187,34 @@ paths: |
4187 | 4187 | schema: |
4188 | 4188 | type: string |
4189 | 4189 | style: form |
| 4190 | + - description: |- |
| 4191 | + Field to sort by. Defaults to created_at (newest first). |
| 4192 | + |
| 4193 | + - VISITOR_SORT_FIELD_UNSPECIFIED: Sort field not specified (defaults to created_at) |
| 4194 | + - VISITOR_SORT_FIELD_CREATED_AT: Sort by the date the visitor was first seen |
| 4195 | + - VISITOR_SORT_FIELD_VISIT_COUNT: Sort by total number of visits (events) |
| 4196 | + - VISITOR_SORT_FIELD_DEVICE_COUNT: Sort by number of attributed devices |
| 4197 | + - VISITOR_SORT_FIELD_QRCODE_COUNT: Sort by number of distinct QR codes interacted with |
| 4198 | + explode: true |
| 4199 | + in: query |
| 4200 | + name: sortField |
| 4201 | + required: false |
| 4202 | + schema: |
| 4203 | + type: string |
| 4204 | + style: form |
| 4205 | + - description: |- |
| 4206 | + Sort direction. Defaults to descending. |
| 4207 | + |
| 4208 | + - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending) |
| 4209 | + - SORT_DIRECTION_ASC: Sort in ascending order |
| 4210 | + - SORT_DIRECTION_DESC: Sort in descending order |
| 4211 | + explode: true |
| 4212 | + in: query |
| 4213 | + name: sortDirection |
| 4214 | + required: false |
| 4215 | + schema: |
| 4216 | + type: string |
| 4217 | + style: form |
4190 | 4218 | responses: |
4191 | 4219 | "200": |
4192 | 4220 | content: |
@@ -7770,9 +7798,8 @@ components: |
7770 | 7798 | action: ACTION_SCAN |
7771 | 7799 | id: 8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a |
7772 | 7800 | visitor: |
7773 | | - createdAt: 2000-01-23T04:56:07.000+00:00 |
7774 | | - firstName: Sam |
7775 | 7801 | lastName: Rivera |
| 7802 | + deviceCount: 2 |
7776 | 7803 | devices: |
7777 | 7804 | - country: US |
7778 | 7805 | screenWidth: 1728 |
@@ -7844,6 +7871,10 @@ components: |
7844 | 7871 | region: CRF |
7845 | 7872 | asn: 7922 |
7846 | 7873 | deviceBrand: Apple |
| 7874 | + qrcodeCount: 3 |
| 7875 | + createdAt: 2000-01-23T04:56:07.000+00:00 |
| 7876 | + firstName: Sam |
| 7877 | + visitCount: 42 |
7847 | 7878 | phone: "+15551234567" |
7848 | 7879 | attributes: "{}" |
7849 | 7880 | links: |
@@ -9885,9 +9916,8 @@ components: |
9885 | 9916 | action: ACTION_SCAN |
9886 | 9917 | id: 8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a |
9887 | 9918 | visitor: |
9888 | | - createdAt: 2000-01-23T04:56:07.000+00:00 |
9889 | | - firstName: Sam |
9890 | 9919 | lastName: Rivera |
| 9920 | + deviceCount: 2 |
9891 | 9921 | devices: |
9892 | 9922 | - country: US |
9893 | 9923 | screenWidth: 1728 |
@@ -9959,6 +9989,10 @@ components: |
9959 | 9989 | region: CRF |
9960 | 9990 | asn: 7922 |
9961 | 9991 | deviceBrand: Apple |
| 9992 | + qrcodeCount: 3 |
| 9993 | + createdAt: 2000-01-23T04:56:07.000+00:00 |
| 9994 | + firstName: Sam |
| 9995 | + visitCount: 42 |
9962 | 9996 | phone: "+15551234567" |
9963 | 9997 | attributes: "{}" |
9964 | 9998 | links: |
@@ -10051,9 +10085,8 @@ components: |
10051 | 10085 | action: ACTION_SCAN |
10052 | 10086 | id: 8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a |
10053 | 10087 | visitor: |
10054 | | - createdAt: 2000-01-23T04:56:07.000+00:00 |
10055 | | - firstName: Sam |
10056 | 10088 | lastName: Rivera |
| 10089 | + deviceCount: 2 |
10057 | 10090 | devices: |
10058 | 10091 | - country: US |
10059 | 10092 | screenWidth: 1728 |
@@ -10125,6 +10158,10 @@ components: |
10125 | 10158 | region: CRF |
10126 | 10159 | asn: 7922 |
10127 | 10160 | deviceBrand: Apple |
| 10161 | + qrcodeCount: 3 |
| 10162 | + createdAt: 2000-01-23T04:56:07.000+00:00 |
| 10163 | + firstName: Sam |
| 10164 | + visitCount: 42 |
10128 | 10165 | phone: "+15551234567" |
10129 | 10166 | attributes: "{}" |
10130 | 10167 | links: |
@@ -10250,9 +10287,8 @@ components: |
10250 | 10287 | action: ACTION_SCAN |
10251 | 10288 | id: 8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a |
10252 | 10289 | visitor: |
10253 | | - createdAt: 2000-01-23T04:56:07.000+00:00 |
10254 | | - firstName: Sam |
10255 | 10290 | lastName: Rivera |
| 10291 | + deviceCount: 2 |
10256 | 10292 | devices: |
10257 | 10293 | - country: US |
10258 | 10294 | screenWidth: 1728 |
@@ -10326,6 +10362,10 @@ components: |
10326 | 10362 | region: CRF |
10327 | 10363 | asn: 7922 |
10328 | 10364 | deviceBrand: Apple |
| 10365 | + qrcodeCount: 3 |
| 10366 | + createdAt: 2000-01-23T04:56:07.000+00:00 |
| 10367 | + firstName: Sam |
| 10368 | + visitCount: 42 |
10329 | 10369 | phone: "+15551234567" |
10330 | 10370 | attributes: "{}" |
10331 | 10371 | links: |
@@ -10418,9 +10458,8 @@ components: |
10418 | 10458 | action: ACTION_SCAN |
10419 | 10459 | id: 8b6e1a2c-7d4f-4fd2-8b35-9a4c1f2d993a |
10420 | 10460 | visitor: |
10421 | | - createdAt: 2000-01-23T04:56:07.000+00:00 |
10422 | | - firstName: Sam |
10423 | 10461 | lastName: Rivera |
| 10462 | + deviceCount: 2 |
10424 | 10463 | devices: |
10425 | 10464 | - country: US |
10426 | 10465 | screenWidth: 1728 |
@@ -10494,6 +10533,10 @@ components: |
10494 | 10533 | region: CRF |
10495 | 10534 | asn: 7922 |
10496 | 10535 | deviceBrand: Apple |
| 10536 | + qrcodeCount: 3 |
| 10537 | + createdAt: 2000-01-23T04:56:07.000+00:00 |
| 10538 | + firstName: Sam |
| 10539 | + visitCount: 42 |
10497 | 10540 | phone: "+15551234567" |
10498 | 10541 | attributes: "{}" |
10499 | 10542 | links: |
@@ -12609,14 +12652,16 @@ components: |
12609 | 12652 | SortDirection: |
12610 | 12653 | default: SORT_DIRECTION_UNSPECIFIED |
12611 | 12654 | description: |- |
12612 | | - - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending) |
| 12655 | + SortDirection is the ordering applied to any sortable list endpoint. |
| 12656 | + Shared across resources so a caller learns it once. |
| 12657 | + |
| 12658 | + - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending) |
12613 | 12659 | - SORT_DIRECTION_ASC: Sort in ascending order |
12614 | 12660 | - SORT_DIRECTION_DESC: Sort in descending order |
12615 | 12661 | enum: |
12616 | 12662 | - SORT_DIRECTION_UNSPECIFIED |
12617 | 12663 | - SORT_DIRECTION_ASC |
12618 | 12664 | - SORT_DIRECTION_DESC |
12619 | | - title: Sort direction for link listing |
12620 | 12665 | type: string |
12621 | 12666 | SpecificDateConditionPayload: |
12622 | 12667 | properties: |
@@ -13545,9 +13590,8 @@ components: |
13545 | 13590 | Captures the cross-link profile Linkbreakers builds for someone who scans or clicks, combining reserved identity fields, |
13546 | 13591 | attributed devices, events, and custom traits gathered from forms. |
13547 | 13592 | example: |
13548 | | - createdAt: 2000-01-23T04:56:07.000+00:00 |
13549 | | - firstName: Sam |
13550 | 13593 | lastName: Rivera |
| 13594 | + deviceCount: 2 |
13551 | 13595 | devices: |
13552 | 13596 | - country: US |
13553 | 13597 | screenWidth: 1728 |
@@ -13619,6 +13663,10 @@ components: |
13619 | 13663 | region: CRF |
13620 | 13664 | asn: 7922 |
13621 | 13665 | deviceBrand: Apple |
| 13666 | + qrcodeCount: 3 |
| 13667 | + createdAt: 2000-01-23T04:56:07.000+00:00 |
| 13668 | + firstName: Sam |
| 13669 | + visitCount: 42 |
13622 | 13670 | phone: "+15551234567" |
13623 | 13671 | attributes: "{}" |
13624 | 13672 | links: |
@@ -13665,6 +13713,11 @@ components: |
13665 | 13713 | format: date-time |
13666 | 13714 | title: Timestamps |
13667 | 13715 | type: string |
| 13716 | + deviceCount: |
| 13717 | + example: 2 |
| 13718 | + format: int64 |
| 13719 | + title: Number of devices attributed to this visitor |
| 13720 | + type: string |
13668 | 13721 | devices: |
13669 | 13722 | items: |
13670 | 13723 | $ref: "#/components/schemas/Device" |
@@ -13701,9 +13754,19 @@ components: |
13701 | 13754 | example: "+15551234567" |
13702 | 13755 | title: from "$phone" |
13703 | 13756 | type: string |
| 13757 | + qrcodeCount: |
| 13758 | + example: 3 |
| 13759 | + format: int64 |
| 13760 | + title: Number of distinct QR codes / links this visitor has interacted with |
| 13761 | + type: string |
13704 | 13762 | updatedAt: |
13705 | 13763 | format: date-time |
13706 | 13764 | type: string |
| 13765 | + visitCount: |
| 13766 | + example: 42 |
| 13767 | + format: int64 |
| 13768 | + title: Total number of events (visits) recorded for this visitor |
| 13769 | + type: string |
13707 | 13770 | workspaceId: |
13708 | 13771 | example: c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0 |
13709 | 13772 | title: Workspace that owns this visitor (UUID) |
@@ -13851,6 +13914,22 @@ components: |
13851 | 13914 | title: Shortlink slug used in public URLs |
13852 | 13915 | type: string |
13853 | 13916 | title: VisitorLink |
| 13917 | + VisitorSortField: |
| 13918 | + default: VISITOR_SORT_FIELD_UNSPECIFIED |
| 13919 | + description: |- |
| 13920 | + - VISITOR_SORT_FIELD_UNSPECIFIED: Sort field not specified (defaults to created_at) |
| 13921 | + - VISITOR_SORT_FIELD_CREATED_AT: Sort by the date the visitor was first seen |
| 13922 | + - VISITOR_SORT_FIELD_VISIT_COUNT: Sort by total number of visits (events) |
| 13923 | + - VISITOR_SORT_FIELD_DEVICE_COUNT: Sort by number of attributed devices |
| 13924 | + - VISITOR_SORT_FIELD_QRCODE_COUNT: Sort by number of distinct QR codes interacted with |
| 13925 | + enum: |
| 13926 | + - VISITOR_SORT_FIELD_UNSPECIFIED |
| 13927 | + - VISITOR_SORT_FIELD_CREATED_AT |
| 13928 | + - VISITOR_SORT_FIELD_VISIT_COUNT |
| 13929 | + - VISITOR_SORT_FIELD_DEVICE_COUNT |
| 13930 | + - VISITOR_SORT_FIELD_QRCODE_COUNT |
| 13931 | + title: Fields that can be used to sort visitors |
| 13932 | + type: string |
13854 | 13933 | VisitorTrendDataPoint: |
13855 | 13934 | example: |
13856 | 13935 | newVisitorCount: 0 |
|
0 commit comments