enbbox 1.0.1

Notification infrastructure API — open-source alternative to Novu/Courier
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

# \ActivityApi

All URIs are relative to *https://api.enbbox.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**activity_chart**](ActivityApi.md#activity_chart) | **GET** /v1/activity/chart/ | GET /v1/activity/chart — activity chart data
[**activity_stats**](ActivityApi.md#activity_stats) | **GET** /v1/activity/stats/ | GET /v1/activity/stats
[**engagement_stats**](ActivityApi.md#engagement_stats) | **GET** /v1/activity/engagement/ | GET /v1/activity/engagement — subscriber engagement stats
[**get_activity_by_notification**](ActivityApi.md#get_activity_by_notification) | **GET** /v1/activity/{notification_id}/ | GET /v1/activity/:notificationId
[**list_activity**](ActivityApi.md#list_activity) | **GET** /v1/activity/ | GET /v1/activity
[**list_activity_requests**](ActivityApi.md#list_activity_requests) | **GET** /v1/activity/requests/ | GET /v1/activity/requests — list trigger requests GET /v1/activity/requests — list trigger requests
[**list_workflow_runs**](ActivityApi.md#list_workflow_runs) | **GET** /v1/activity/workflow-runs/ | GET /v1/activity/workflow-runs — list workflow executions
[**workflow_stats**](ActivityApi.md#workflow_stats) | **GET** /v1/activity/workflows/stats/ | GET /v1/activity/workflows/stats — workflow execution stats



## activity_chart

> Vec<models::ActivityChartPoint> activity_chart(days)
GET /v1/activity/chart — activity chart data

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**days** | Option<**u32**> | Number of days to include in the chart (1–365, default: 30). |  |

### Return type

[**Vec<models::ActivityChartPoint>**](ActivityChartPoint.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## activity_stats

> models::ActivityStats activity_stats()
GET /v1/activity/stats

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::ActivityStats**](ActivityStats.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## engagement_stats

> models::EngagementStats engagement_stats()
GET /v1/activity/engagement — subscriber engagement stats

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::EngagementStats**](EngagementStats.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_activity_by_notification

> Vec<models::ActivityRecord> get_activity_by_notification(notification_id)
GET /v1/activity/:notificationId

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**notification_id** | **uuid::Uuid** | Notification ID | [required] |

### Return type

[**Vec<models::ActivityRecord>**](ActivityRecord.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_activity

> models::PaginatedActivityRecord list_activity(limit, offset, q, filter_by)
GET /v1/activity

Lists activity (execution details) for the current project. Supports full-text search via `q` and Typesense filter expressions via `filter_by`.  **Filter examples:** - `filter_by=status:=success` - `filter_by=provider_id:=telegram` - `filter_by=status:=[success,Success] && provider_id:=telegram`

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 10). |  |
**offset** | Option<**u32**> | Number of items to skip before returning results (default: 0). |  |
**q** | Option<**String**> | Optional full-text search query. When present, listing is powered by Typesense full-text search. |  |
**filter_by** | Option<**String**> | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. |  |

### Return type

[**models::PaginatedActivityRecord**](Paginated_ActivityRecord.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_activity_requests

> Vec<models::ActivityRequestRecord> list_activity_requests(limit, offset, q, filter_by)
GET /v1/activity/requests — list trigger requests GET /v1/activity/requests — list trigger requests

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 10). |  |
**offset** | Option<**u32**> | Number of items to skip before returning results (default: 0). |  |
**q** | Option<**String**> | Optional full-text search query. When present, listing is powered by Typesense full-text search. |  |
**filter_by** | Option<**String**> | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. |  |

### Return type

[**Vec<models::ActivityRequestRecord>**](ActivityRequestRecord.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_workflow_runs

> Vec<models::WorkflowRunRecord> list_workflow_runs(limit, offset, q, filter_by)
GET /v1/activity/workflow-runs — list workflow executions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 10). |  |
**offset** | Option<**u32**> | Number of items to skip before returning results (default: 0). |  |
**q** | Option<**String**> | Optional full-text search query. When present, listing is powered by Typesense full-text search. |  |
**filter_by** | Option<**String**> | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. |  |

### Return type

[**Vec<models::WorkflowRunRecord>**](WorkflowRunRecord.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## workflow_stats

> models::WorkflowStats workflow_stats()
GET /v1/activity/workflows/stats — workflow execution stats

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::WorkflowStats**](WorkflowStats.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)