ultracart_api 4.1.178 → 4.1.179
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +11 -2
- data/docs/SfvbApi.md +111 -0
- data/docs/SfvbRecording.md +60 -0
- data/docs/SfvbRecordingEvent.md +24 -0
- data/docs/SfvbRecordingEventsResponse.md +24 -0
- data/docs/SfvbRecordingPageView.md +42 -0
- data/docs/SfvbRecordingParameter.md +20 -0
- data/docs/SfvbRecordingResponse.md +18 -0
- data/lib/ultracart_api/api/sfvb_api.rb +146 -0
- data/lib/ultracart_api/models/sfvb_recording.rb +431 -0
- data/lib/ultracart_api/models/sfvb_recording_event.rb +252 -0
- data/lib/ultracart_api/models/sfvb_recording_events_response.rb +250 -0
- data/lib/ultracart_api/models/sfvb_recording_page_view.rb +344 -0
- data/lib/ultracart_api/models/sfvb_recording_parameter.rb +230 -0
- data/lib/ultracart_api/models/sfvb_recording_response.rb +219 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7be2900314bb7fd6dbb8b131e2ec81241b554295c1f0e0a8f358351c85bd2fc9
|
|
4
|
+
data.tar.gz: ed5d67d6b4a183517fcba0bb7648dbbcd3c04e50f37e1a4d8615069763eea627
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8d0665e462f12b907302102007ff4a4cbde6f01fa071d0159d5b8e93b9f7444558493651ce13ed0bea8bf8280a88877f97f79fab86b4d3dbc9cb667a713da00f
|
|
7
|
+
data.tar.gz: '086081a72686f31419a1644b82921ba67f4b4736e64870be4c8554ef61850f4e8df6b9bcc903b075aca724cab43f3c975d9abc8991a82e7b67a9cb1e45796a6b'
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.1.
|
|
10
|
+
- Package version: 4.1.179
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.179'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -512,6 +512,8 @@ Class | Method | HTTP request | Description
|
|
|
512
512
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_items**](docs/SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page
|
|
513
513
|
*UltracartClient::SfvbApi* | [**get_sfvb_page_selectors**](docs/SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors
|
|
514
514
|
*UltracartClient::SfvbApi* | [**get_sfvb_preview_url**](docs/SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session
|
|
515
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_recording**](docs/SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording
|
|
516
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_recording_page_view_events**](docs/SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events
|
|
515
517
|
*UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
|
|
516
518
|
*UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
|
|
517
519
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
|
|
@@ -1881,6 +1883,12 @@ Class | Method | HTTP request | Description
|
|
|
1881
1883
|
- [UltracartClient::SfvbPreviewSessionRequest](docs/SfvbPreviewSessionRequest.md)
|
|
1882
1884
|
- [UltracartClient::SfvbPreviewSessionResponse](docs/SfvbPreviewSessionResponse.md)
|
|
1883
1885
|
- [UltracartClient::SfvbPreviewUrlResponse](docs/SfvbPreviewUrlResponse.md)
|
|
1886
|
+
- [UltracartClient::SfvbRecording](docs/SfvbRecording.md)
|
|
1887
|
+
- [UltracartClient::SfvbRecordingEvent](docs/SfvbRecordingEvent.md)
|
|
1888
|
+
- [UltracartClient::SfvbRecordingEventsResponse](docs/SfvbRecordingEventsResponse.md)
|
|
1889
|
+
- [UltracartClient::SfvbRecordingPageView](docs/SfvbRecordingPageView.md)
|
|
1890
|
+
- [UltracartClient::SfvbRecordingParameter](docs/SfvbRecordingParameter.md)
|
|
1891
|
+
- [UltracartClient::SfvbRecordingResponse](docs/SfvbRecordingResponse.md)
|
|
1884
1892
|
- [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
|
|
1885
1893
|
- [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
|
|
1886
1894
|
- [UltracartClient::SfvbServerLog](docs/SfvbServerLog.md)
|
|
@@ -2096,6 +2104,7 @@ Not every change is committed to every SDK.
|
|
|
2096
2104
|
|
|
2097
2105
|
| Version | Date | Comments |
|
|
2098
2106
|
| --: | :-: | --- |
|
|
2107
|
+
| 4.1.179 | 10/01/2026 | sfvb internal testing |
|
|
2099
2108
|
| 4.1.178 | 09/30/2026 | sfvb internal testing |
|
|
2100
2109
|
| 4.1.177 | 09/30/2026 | sfvb internal testing |
|
|
2101
2110
|
| 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -44,6 +44,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
44
44
|
| [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
|
|
45
45
|
| [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
|
|
46
46
|
| [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
|
|
47
|
+
| [**get_sfvb_recording**](SfvbApi.md#get_sfvb_recording) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid} | Get a screen recording |
|
|
48
|
+
| [**get_sfvb_recording_page_view_events**](SfvbApi.md#get_sfvb_recording_page_view_events) | **GET** /sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events | Get one recorded page view's replay events |
|
|
47
49
|
| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
|
|
48
50
|
| [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
|
|
49
51
|
| [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
|
|
@@ -2284,6 +2286,115 @@ end
|
|
|
2284
2286
|
- **Accept**: application/json
|
|
2285
2287
|
|
|
2286
2288
|
|
|
2289
|
+
## get_sfvb_recording
|
|
2290
|
+
|
|
2291
|
+
> <SfvbRecordingResponse> get_sfvb_recording(storefront_oid, screen_recording_uuid)
|
|
2292
|
+
|
|
2293
|
+
Get a screen recording
|
|
2294
|
+
|
|
2295
|
+
One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view's replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
### Examples
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
(No example for this operation).
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
#### Using the get_sfvb_recording_with_http_info variant
|
|
2305
|
+
|
|
2306
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2307
|
+
|
|
2308
|
+
> <Array(<SfvbRecordingResponse>, Integer, Hash)> get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid)
|
|
2309
|
+
|
|
2310
|
+
```ruby
|
|
2311
|
+
begin
|
|
2312
|
+
# Get a screen recording
|
|
2313
|
+
data, status_code, headers = api_instance.get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid)
|
|
2314
|
+
p status_code # => 2xx
|
|
2315
|
+
p headers # => { ... }
|
|
2316
|
+
p data # => <SfvbRecordingResponse>
|
|
2317
|
+
rescue UltracartClient::ApiError => e
|
|
2318
|
+
puts "Error when calling SfvbApi->get_sfvb_recording_with_http_info: #{e}"
|
|
2319
|
+
end
|
|
2320
|
+
```
|
|
2321
|
+
|
|
2322
|
+
### Parameters
|
|
2323
|
+
|
|
2324
|
+
| Name | Type | Description | Notes |
|
|
2325
|
+
| ---- | ---- | ----------- | ----- |
|
|
2326
|
+
| **storefront_oid** | **Integer** | | |
|
|
2327
|
+
| **screen_recording_uuid** | **String** | | |
|
|
2328
|
+
|
|
2329
|
+
### Return type
|
|
2330
|
+
|
|
2331
|
+
[**SfvbRecordingResponse**](SfvbRecordingResponse.md)
|
|
2332
|
+
|
|
2333
|
+
### Authorization
|
|
2334
|
+
|
|
2335
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2336
|
+
|
|
2337
|
+
### HTTP request headers
|
|
2338
|
+
|
|
2339
|
+
- **Content-Type**: Not defined
|
|
2340
|
+
- **Accept**: application/json
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
## get_sfvb_recording_page_view_events
|
|
2344
|
+
|
|
2345
|
+
> <SfvbRecordingEventsResponse> get_sfvb_recording_page_view_events(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
|
|
2346
|
+
|
|
2347
|
+
Get one recorded page view's replay events
|
|
2348
|
+
|
|
2349
|
+
The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
2350
|
+
|
|
2351
|
+
|
|
2352
|
+
### Examples
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
(No example for this operation).
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
#### Using the get_sfvb_recording_page_view_events_with_http_info variant
|
|
2359
|
+
|
|
2360
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2361
|
+
|
|
2362
|
+
> <Array(<SfvbRecordingEventsResponse>, Integer, Hash)> get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
|
|
2363
|
+
|
|
2364
|
+
```ruby
|
|
2365
|
+
begin
|
|
2366
|
+
# Get one recorded page view's replay events
|
|
2367
|
+
data, status_code, headers = api_instance.get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
|
|
2368
|
+
p status_code # => 2xx
|
|
2369
|
+
p headers # => { ... }
|
|
2370
|
+
p data # => <SfvbRecordingEventsResponse>
|
|
2371
|
+
rescue UltracartClient::ApiError => e
|
|
2372
|
+
puts "Error when calling SfvbApi->get_sfvb_recording_page_view_events_with_http_info: #{e}"
|
|
2373
|
+
end
|
|
2374
|
+
```
|
|
2375
|
+
|
|
2376
|
+
### Parameters
|
|
2377
|
+
|
|
2378
|
+
| Name | Type | Description | Notes |
|
|
2379
|
+
| ---- | ---- | ----------- | ----- |
|
|
2380
|
+
| **storefront_oid** | **Integer** | | |
|
|
2381
|
+
| **screen_recording_uuid** | **String** | | |
|
|
2382
|
+
| **screen_recording_page_view_uuid** | **String** | | |
|
|
2383
|
+
|
|
2384
|
+
### Return type
|
|
2385
|
+
|
|
2386
|
+
[**SfvbRecordingEventsResponse**](SfvbRecordingEventsResponse.md)
|
|
2387
|
+
|
|
2388
|
+
### Authorization
|
|
2389
|
+
|
|
2390
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2391
|
+
|
|
2392
|
+
### HTTP request headers
|
|
2393
|
+
|
|
2394
|
+
- **Content-Type**: Not defined
|
|
2395
|
+
- **Accept**: application/json
|
|
2396
|
+
|
|
2397
|
+
|
|
2287
2398
|
## get_sfvb_server_log
|
|
2288
2399
|
|
|
2289
2400
|
> <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecording
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ad_platform** | [**ScreenRecordingAdPlatform**](ScreenRecordingAdPlatform.md) | | [optional] |
|
|
8
|
+
| **browser** | **String** | Browser name from the user agent. | [optional] |
|
|
9
|
+
| **browser_version** | **String** | Browser version from the user agent. | [optional] |
|
|
10
|
+
| **converted** | **Boolean** | True when the session ended in an order. | [optional] |
|
|
11
|
+
| **device** | **String** | Device name from the user agent. | [optional] |
|
|
12
|
+
| **end_timestamp** | **String** | When the session ended, ISO-8601 in UTC. | [optional] |
|
|
13
|
+
| **geolocation_country** | **String** | Country the visitor was in. | [optional] |
|
|
14
|
+
| **geolocation_state** | **String** | State or region the visitor was in. | [optional] |
|
|
15
|
+
| **language_iso_code** | **String** | The browser language. | [optional] |
|
|
16
|
+
| **order_id** | **String** | The order placed during the session, when there was one. | [optional] |
|
|
17
|
+
| **os** | **String** | Operating system from the user agent. | [optional] |
|
|
18
|
+
| **page_view_count** | **Integer** | How many pages the visitor viewed. | [optional] |
|
|
19
|
+
| **page_views** | [**Array<SfvbRecordingPageView>**](SfvbRecordingPageView.md) | The pages viewed, in order. | [optional] |
|
|
20
|
+
| **referrer_domain** | **String** | The domain that referred the visitor. | [optional] |
|
|
21
|
+
| **rrweb_version** | **String** | The rrweb version that recorded the session. Replay with the same version. | [optional] |
|
|
22
|
+
| **screen_recording_uuid** | **String** | Identifies the recording. | [optional] |
|
|
23
|
+
| **start_timestamp** | **String** | When the session started, ISO-8601 in UTC. | [optional] |
|
|
24
|
+
| **time_on_site** | **Integer** | Seconds the visitor spent on the site. | [optional] |
|
|
25
|
+
| **utm_campaign** | **String** | utm_campaign on arrival. | [optional] |
|
|
26
|
+
| **utm_source** | **String** | utm_source on arrival. | [optional] |
|
|
27
|
+
| **window_height** | **Integer** | Browser window height in pixels. | [optional] |
|
|
28
|
+
| **window_width** | **Integer** | Browser window width in pixels. | [optional] |
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'ultracart_api'
|
|
34
|
+
|
|
35
|
+
instance = UltracartClient::SfvbRecording.new(
|
|
36
|
+
ad_platform: null,
|
|
37
|
+
browser: null,
|
|
38
|
+
browser_version: null,
|
|
39
|
+
converted: null,
|
|
40
|
+
device: null,
|
|
41
|
+
end_timestamp: null,
|
|
42
|
+
geolocation_country: null,
|
|
43
|
+
geolocation_state: null,
|
|
44
|
+
language_iso_code: null,
|
|
45
|
+
order_id: null,
|
|
46
|
+
os: null,
|
|
47
|
+
page_view_count: null,
|
|
48
|
+
page_views: null,
|
|
49
|
+
referrer_domain: null,
|
|
50
|
+
rrweb_version: null,
|
|
51
|
+
screen_recording_uuid: null,
|
|
52
|
+
start_timestamp: null,
|
|
53
|
+
time_on_site: null,
|
|
54
|
+
utm_campaign: null,
|
|
55
|
+
utm_source: null,
|
|
56
|
+
window_height: null,
|
|
57
|
+
window_width: null
|
|
58
|
+
)
|
|
59
|
+
```
|
|
60
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingEvent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The event name, such as rage click, script error, checkout error or add to cart. | [optional] |
|
|
8
|
+
| **params** | [**Array<SfvbRecordingParameter>**](SfvbRecordingParameter.md) | The event's parameters as name and value pairs. Omitted for input change events, whose values are what the visitor typed. | [optional] |
|
|
9
|
+
| **sub_text** | **String** | A short human readable summary of the event, when the recorder produced one. | [optional] |
|
|
10
|
+
| **timestamp** | **String** | When it happened, ISO-8601 in UTC. Subtract the page view's first_event_timestamp for the offset into the replay. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbRecordingEvent.new(
|
|
18
|
+
name: null,
|
|
19
|
+
params: null,
|
|
20
|
+
sub_text: null,
|
|
21
|
+
timestamp: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingEventsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **events_json** | **String** | The page view's rrweb events as a JSON array in a string, the input an rrweb Replayer takes. Card number and security code fields are masked by the recorder, but other text the visitor typed can appear in it. | [optional] |
|
|
8
|
+
| **rrweb_version** | **String** | The rrweb version that recorded the events. Replay with the same version. | [optional] |
|
|
9
|
+
| **screen_recording_page_view_uuid** | **String** | The page view these events replay. | [optional] |
|
|
10
|
+
| **screen_recording_uuid** | **String** | The recording the page view belongs to. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbRecordingEventsResponse.new(
|
|
18
|
+
events_json: null,
|
|
19
|
+
rrweb_version: null,
|
|
20
|
+
screen_recording_page_view_uuid: null,
|
|
21
|
+
screen_recording_uuid: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingPageView
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **domain** | **String** | The host name of the address. | [optional] |
|
|
8
|
+
| **events** | [**Array<SfvbRecordingEvent>**](SfvbRecordingEvent.md) | Named events on this page view in time order, such as rage clicks and script errors. | [optional] |
|
|
9
|
+
| **first_event_timestamp** | **String** | When recording of this page view began, ISO-8601 in UTC. | [optional] |
|
|
10
|
+
| **last_event_timestamp** | **String** | When recording of this page view ended, ISO-8601 in UTC. | [optional] |
|
|
11
|
+
| **missing_events** | **Boolean** | True when no replay events were stored for this page view. | [optional] |
|
|
12
|
+
| **params** | [**Array<SfvbRecordingParameter>**](SfvbRecordingParameter.md) | The query string parameters on the address. | [optional] |
|
|
13
|
+
| **referrer** | **String** | The referring address, when there was one. | [optional] |
|
|
14
|
+
| **screen_recording_page_view_uuid** | **String** | Identifies this page view when fetching its replay events. | [optional] |
|
|
15
|
+
| **time_on_page** | **Integer** | Seconds the visitor spent on the page. | [optional] |
|
|
16
|
+
| **timing_dom_content_loaded** | **Integer** | Milliseconds until DOMContentLoaded fired. | [optional] |
|
|
17
|
+
| **timing_loaded** | **Integer** | Milliseconds until the load event fired. | [optional] |
|
|
18
|
+
| **truncated_events** | **Boolean** | True when the recorder stopped storing events part way through this page view. | [optional] |
|
|
19
|
+
| **url** | **String** | The address the visitor viewed. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'ultracart_api'
|
|
25
|
+
|
|
26
|
+
instance = UltracartClient::SfvbRecordingPageView.new(
|
|
27
|
+
domain: null,
|
|
28
|
+
events: null,
|
|
29
|
+
first_event_timestamp: null,
|
|
30
|
+
last_event_timestamp: null,
|
|
31
|
+
missing_events: null,
|
|
32
|
+
params: null,
|
|
33
|
+
referrer: null,
|
|
34
|
+
screen_recording_page_view_uuid: null,
|
|
35
|
+
time_on_page: null,
|
|
36
|
+
timing_dom_content_loaded: null,
|
|
37
|
+
timing_loaded: null,
|
|
38
|
+
truncated_events: null,
|
|
39
|
+
url: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingParameter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Parameter name. | [optional] |
|
|
8
|
+
| **value** | **String** | Parameter value as text. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbRecordingParameter.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbRecordingResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **recording** | [**SfvbRecording**](SfvbRecording.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbRecordingResponse.new(
|
|
15
|
+
recording: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -2930,6 +2930,152 @@ module UltracartClient
|
|
|
2930
2930
|
return data, status_code, headers
|
|
2931
2931
|
end
|
|
2932
2932
|
|
|
2933
|
+
# Get a screen recording
|
|
2934
|
+
# One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view's replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2935
|
+
# @param storefront_oid [Integer]
|
|
2936
|
+
# @param screen_recording_uuid [String]
|
|
2937
|
+
# @param [Hash] opts the optional parameters
|
|
2938
|
+
# @return [SfvbRecordingResponse]
|
|
2939
|
+
def get_sfvb_recording(storefront_oid, screen_recording_uuid, opts = {})
|
|
2940
|
+
data, _status_code, _headers = get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid, opts)
|
|
2941
|
+
data
|
|
2942
|
+
end
|
|
2943
|
+
|
|
2944
|
+
# Get a screen recording
|
|
2945
|
+
# One recorded visitor session and its page views, with each page view's named events such as rage clicks, script errors and checkout errors, but without the replay data. Fetch a page view's replay events separately. Find recordings to look at from the heatmaps or the analytics warehouse. The visitor's email, IP address and visitor id are not returned, nor what they typed into form fields. Reading a recording does not mark it watched.
|
|
2946
|
+
# @param storefront_oid [Integer]
|
|
2947
|
+
# @param screen_recording_uuid [String]
|
|
2948
|
+
# @param [Hash] opts the optional parameters
|
|
2949
|
+
# @return [Array<(SfvbRecordingResponse, Integer, Hash)>] SfvbRecordingResponse data, response status code and response headers
|
|
2950
|
+
def get_sfvb_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {})
|
|
2951
|
+
if @api_client.config.debugging
|
|
2952
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording ...'
|
|
2953
|
+
end
|
|
2954
|
+
# verify the required parameter 'storefront_oid' is set
|
|
2955
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
2956
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_recording"
|
|
2957
|
+
end
|
|
2958
|
+
# verify the required parameter 'screen_recording_uuid' is set
|
|
2959
|
+
if @api_client.config.client_side_validation && screen_recording_uuid.nil?
|
|
2960
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling SfvbApi.get_sfvb_recording"
|
|
2961
|
+
end
|
|
2962
|
+
# resource path
|
|
2963
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))
|
|
2964
|
+
|
|
2965
|
+
# query parameters
|
|
2966
|
+
query_params = opts[:query_params] || {}
|
|
2967
|
+
|
|
2968
|
+
# header parameters
|
|
2969
|
+
header_params = opts[:header_params] || {}
|
|
2970
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2971
|
+
# HTTP header 'Accept' (if needed)
|
|
2972
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2973
|
+
|
|
2974
|
+
# form parameters
|
|
2975
|
+
form_params = opts[:form_params] || {}
|
|
2976
|
+
|
|
2977
|
+
# http body (model)
|
|
2978
|
+
post_body = opts[:debug_body]
|
|
2979
|
+
|
|
2980
|
+
# return_type
|
|
2981
|
+
return_type = opts[:debug_return_type] || 'SfvbRecordingResponse'
|
|
2982
|
+
|
|
2983
|
+
# auth_names
|
|
2984
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2985
|
+
|
|
2986
|
+
new_options = opts.merge(
|
|
2987
|
+
:operation => :"SfvbApi.get_sfvb_recording",
|
|
2988
|
+
:header_params => header_params,
|
|
2989
|
+
:query_params => query_params,
|
|
2990
|
+
:form_params => form_params,
|
|
2991
|
+
:body => post_body,
|
|
2992
|
+
:auth_names => auth_names,
|
|
2993
|
+
:return_type => return_type
|
|
2994
|
+
)
|
|
2995
|
+
|
|
2996
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2997
|
+
if @api_client.config.debugging
|
|
2998
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2999
|
+
end
|
|
3000
|
+
return data, status_code, headers
|
|
3001
|
+
end
|
|
3002
|
+
|
|
3003
|
+
# Get one recorded page view's replay events
|
|
3004
|
+
# The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
3005
|
+
# @param storefront_oid [Integer]
|
|
3006
|
+
# @param screen_recording_uuid [String]
|
|
3007
|
+
# @param screen_recording_page_view_uuid [String]
|
|
3008
|
+
# @param [Hash] opts the optional parameters
|
|
3009
|
+
# @return [SfvbRecordingEventsResponse]
|
|
3010
|
+
def get_sfvb_recording_page_view_events(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
|
|
3011
|
+
data, _status_code, _headers = get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts)
|
|
3012
|
+
data
|
|
3013
|
+
end
|
|
3014
|
+
|
|
3015
|
+
# Get one recorded page view's replay events
|
|
3016
|
+
# The rrweb events for one page view, as a JSON array in a string, for replaying on the caller's own machine. Card fields are masked by the recorder, but other text the visitor typed can appear. Limited per account to 30 page views a minute, 300 an hour and 1000 a day. Reading the events does not mark the recording watched.
|
|
3017
|
+
# @param storefront_oid [Integer]
|
|
3018
|
+
# @param screen_recording_uuid [String]
|
|
3019
|
+
# @param screen_recording_page_view_uuid [String]
|
|
3020
|
+
# @param [Hash] opts the optional parameters
|
|
3021
|
+
# @return [Array<(SfvbRecordingEventsResponse, Integer, Hash)>] SfvbRecordingEventsResponse data, response status code and response headers
|
|
3022
|
+
def get_sfvb_recording_page_view_events_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
|
|
3023
|
+
if @api_client.config.debugging
|
|
3024
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_recording_page_view_events ...'
|
|
3025
|
+
end
|
|
3026
|
+
# verify the required parameter 'storefront_oid' is set
|
|
3027
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
3028
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_recording_page_view_events"
|
|
3029
|
+
end
|
|
3030
|
+
# verify the required parameter 'screen_recording_uuid' is set
|
|
3031
|
+
if @api_client.config.client_side_validation && screen_recording_uuid.nil?
|
|
3032
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling SfvbApi.get_sfvb_recording_page_view_events"
|
|
3033
|
+
end
|
|
3034
|
+
# verify the required parameter 'screen_recording_page_view_uuid' is set
|
|
3035
|
+
if @api_client.config.client_side_validation && screen_recording_page_view_uuid.nil?
|
|
3036
|
+
fail ArgumentError, "Missing the required parameter 'screen_recording_page_view_uuid' when calling SfvbApi.get_sfvb_recording_page_view_events"
|
|
3037
|
+
end
|
|
3038
|
+
# resource path
|
|
3039
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s)).sub('{' + 'screen_recording_page_view_uuid' + '}', CGI.escape(screen_recording_page_view_uuid.to_s))
|
|
3040
|
+
|
|
3041
|
+
# query parameters
|
|
3042
|
+
query_params = opts[:query_params] || {}
|
|
3043
|
+
|
|
3044
|
+
# header parameters
|
|
3045
|
+
header_params = opts[:header_params] || {}
|
|
3046
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
3047
|
+
# HTTP header 'Accept' (if needed)
|
|
3048
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3049
|
+
|
|
3050
|
+
# form parameters
|
|
3051
|
+
form_params = opts[:form_params] || {}
|
|
3052
|
+
|
|
3053
|
+
# http body (model)
|
|
3054
|
+
post_body = opts[:debug_body]
|
|
3055
|
+
|
|
3056
|
+
# return_type
|
|
3057
|
+
return_type = opts[:debug_return_type] || 'SfvbRecordingEventsResponse'
|
|
3058
|
+
|
|
3059
|
+
# auth_names
|
|
3060
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
3061
|
+
|
|
3062
|
+
new_options = opts.merge(
|
|
3063
|
+
:operation => :"SfvbApi.get_sfvb_recording_page_view_events",
|
|
3064
|
+
:header_params => header_params,
|
|
3065
|
+
:query_params => query_params,
|
|
3066
|
+
:form_params => form_params,
|
|
3067
|
+
:body => post_body,
|
|
3068
|
+
:auth_names => auth_names,
|
|
3069
|
+
:return_type => return_type
|
|
3070
|
+
)
|
|
3071
|
+
|
|
3072
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
3073
|
+
if @api_client.config.debugging
|
|
3074
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_recording_page_view_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3075
|
+
end
|
|
3076
|
+
return data, status_code, headers
|
|
3077
|
+
end
|
|
3078
|
+
|
|
2933
3079
|
# Get one storefront render log
|
|
2934
3080
|
# One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2935
3081
|
# @param storefront_oid [Integer]
|