PEC-Developer/Current/WebAPIs/Statistics Notifications - Revision history

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Statistics Notifications API }} == Base path: /statistics/v3 ==

2023-11-26T04:31:27Z

Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Statistics Notifications API }} == Base path: /statistics/v3 ==  <div class="web-api-post mw-co..."

New page
{{ArticleUnstructured
|Standalone=No
|DisplayName=Statistics Notifications API
}}

== Base path: /statistics/v3 ==


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/notifications</div>
<div class="web-api-summary">CometD endpoint</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">CometD endpoint</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| 500
| Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/statistics/v3/notifications?"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/notifications/connect</div>
<div class="web-api-summary">CometD connect</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">See the [https://docs.cometd.org/current/reference/#_bayeux_meta_connect CometD documentation] for details.</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| 500
| Internal Server Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/statistics/v3/notifications/connect?"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/notifications/disconnect</div>
<div class="web-api-summary">CometD disconnect</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">See the [https://docs.cometd.org/current/reference/#_bayeux_meta_disconnect CometD documentation] for details.</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| 500
| Internal Server Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/statistics/v3/notifications/disconnect?"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/notifications/handshake</div>
<div class="web-api-summary">CometD handshake</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">See the [https://docs.cometd.org/current/reference/#_bayeux_meta_handshake CometD documentation] for details.</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| 500
| Internal Server Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/statistics/v3/notifications/handshake?"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/notifications/subscribe</div>
<div class="web-api-summary">Subscribe to CometD channel notification</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">See the [https://docs.cometd.org/current/reference/#_bayeux_meta_subscribe CometD documentation] for details.

Current channels:
* <tt>/statistics/v3/service</tt> - information about service state
* <tt>/statistics/v3/updates</tt> - statistics updates</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| 500
| Internal Server Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/statistics/v3/notifications/subscribe?"
</source>
</div>
</div>


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/notifications/unsubscribe</div>
<div class="web-api-summary">Unsubscribe from CometD channel notification</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">See the [https://docs.cometd.org/current/reference/#_bayeux_meta_unsubscribe CometD documentation] for details.</div>
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Ok
|-
| 500
| Internal Server Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/statistics/v3/notifications/unsubscribe?"
</source>
</div>
</div>