Semantria
  1. Statistics
Semantria
  • Blacklist
    • Remove items from blacklist
      DELETE
    • Retrieve blacklisted items
      GET
    • Add items to blacklist
      POST
    • Update items in blacklist
      PUT
  • Categories
    • Remove user categories
      DELETE
    • Retrieve user categories
      GET
    • Add user categories
      POST
    • Updates user categories
      PUT
  • ProcessingCollections
    • Queue collection for analysis
      POST
    • Retrieve collections analysis
      GET
    • Cancel collection analysis
      DELETE
    • Retrieve collection analysis or its status in queue
      GET
  • Configuration
    • Remove user configurations
      DELETE
    • Retrieve user configurations
      GET
    • Create user configurations
      POST
    • Update user configurations
      PUT
  • ProcessingDocuments
    • Queue document for analysis
      POST
    • Queue batch of documents for analysis
      POST
    • Retrieve documents analysis
      GET
    • Cancel document analysis
      DELETE
    • Retrieve document analysis or its status in queue
      GET
  • Entities
    • Remove user entities
      DELETE
    • Retrieve user entities
      GET
    • Add user entities
      POST
    • Update user entities
      PUT
  • Features
    • Retrieve supported features
  • Phrases
    • Remove sentiment-bearing phrases
    • Retrieve sentiment-bearing phrases
    • Add sentiment-bearing phrases
    • Updates sentiment-bearing phrases
  • Queries
    • Remove queries
    • Retrieve queries
    • Add or update queries
    • Update queries
  • Statistics
    • Retrieve usage statistics
      GET
  • Status
    • Retrieve API status
  • Subscription
    • Retrieve subscription details
  • Taxonomy
    • Remove taxonomy nodes
    • Retrieve taxonomy
    • Add taxonomy nodes
    • Update taxonomy nodes
  1. Statistics

Retrieve usage statistics

GET
/statistics.{content_type}
This method retrieves overall and per configuration usage statistics for specific timeframe. Statistics ordered per available configurations. Available interval values are current hour, day, week, month and year.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.semantria.com//statistics.'
Response Response Example
200 - Example 1
{
    "calls_data": 0,
    "calls_polling": 0,
    "calls_settings": 0,
    "colls_documents": 0,
    "colls_failed": 0,
    "colls_processed": 0,
    "colls_responded": 0,
    "configurations": [
        {
            "calls_data": 0,
            "calls_polling": 0,
            "calls_settings": 0,
            "colls_failed": 0,
            "colls_processed": 0,
            "colls_responded": 0,
            "config_id": "string",
            "docs_failed": 0,
            "docs_processed": 0,
            "docs_responded": 0,
            "latest_used_app": "string",
            "name": "string",
            "overall_batches": 0,
            "overall_calls": 0,
            "overall_docs": 0,
            "overall_exceeded": 0,
            "overall_texts": 0,
            "overcall_colls": 0,
            "used_apps": "string"
        }
    ],
    "docs_failed": 0,
    "docs_processed": 0,
    "docs_responded": 0,
    "latest_used_app": "string",
    "name": "string",
    "overall_batches": 0,
    "overall_calls": 0,
    "overall_docs": 0,
    "overall_exceeded": 0,
    "overall_texts": 0,
    "overcall_colls": 0,
    "status": "string",
    "used_apps": "string"
}

Request

Path Params
content_type
string 
required
Query Params
config_id
string 
optional
Configuration identifier for usage statistics retrieving.
interval
string 
optional
Hour, Day, Week, Month, Year values are supported.

Responses

🟢200Client request accepted. Server responds with statistics details.
application/json
Body
calls_data
integer 
required
Total number of data API calls made. These affect you API balance
>= 0
calls_polling
integer 
required
Total number of polling API calls made. These do not affect API balance
>= 0
calls_settings
integer 
required
Total number of settings API calls made. These do not affect API balance
>= 0
colls_documents
integer 
required
Total number of documents that have been queued into collections
>= 0
colls_failed
integer 
required
Total number of collections that have failed to be processed
>= 0
colls_processed
integer 
required
Total numbers of collections that have been successfully processed
>= 0
colls_responded
integer 
required
Total number of successfully processed collections that have been returned
>= 0
configurations
array[object (StatisticConfiguration) {19}] 
required
Includes statistics per specific configuration
calls_data
integer 
required
Total number of data API calls made. These affect you API balance
>= 0
calls_polling
integer 
required
Total number of polling API calls made. These do not affect API balance
>= 0
calls_settings
integer 
required
Total number of settings API calls made. These do not affect API balance
>= 0
colls_failed
integer 
required
Total number of collections that have failed to be processed
>= 0
colls_processed
integer 
required
Total numbers of collections that have been successfully processed
>= 0
colls_responded
integer 
required
Total number of successfully processed collections that have been returned
>= 0
config_id
string 
required
Unique identifier of configuration
docs_failed
integer 
required
Total number of documents that have failed to be processed
>= 0
docs_processed
integer 
required
Total number of documents that have been successfully processed
>= 0
docs_responded
integer 
required
Total number of successfully processed documents that have been returned
>= 0
latest_used_app
string 
required
The latest application that used the API on this account
name
string 
required
The name of configuration
overall_batches
integer 
required
Total number of queued batches of texts processed
>= 0
overall_calls
integer 
required
Total number of API calls made
>= 0
overall_docs
integer 
required
Total number of documents that have been queued
>= 0
overall_exceeded
integer 
required
Total number of documents that have exceeded the favorable (suggested) limit
>= 0
overall_texts
integer 
required
Total number of texts processed
>= 0
overcall_colls
integer 
required
Total numbers of collections that have been queued
>= 0
used_apps
string 
required
A list of all the applications that have used the API on this account
docs_failed
integer 
required
Total number of documents that have failed to be processed
>= 0
docs_processed
integer 
required
Total number of documents that have been successfully processed
>= 0
docs_responded
integer 
required
Total number of successfully processed documents that have been returned
>= 0
latest_used_app
string 
required
The latest application that used the API on this account
name
string 
required
Semantria subscriber name. Usually email
overall_batches
integer 
required
Total number of queued batches of texts processed
>= 0
overall_calls
integer 
required
Total number of API calls made
>= 0
overall_docs
integer 
required
Total number of documents that have been queued
>= 0
overall_exceeded
integer 
required
Total number of documents that have exceeded the favorable (suggested) limit
>= 0
overall_texts
integer 
required
Total number of texts processed
>= 0
overcall_colls
integer 
required
Total numbers of collections that have been queued
>= 0
status
string 
required
Semantria subscriber status. Can be active, expired, disabled, etc
used_apps
string 
required
A list of all the applications that have used the API on this account
🟠401Authentication failed.
🟠402Unauthorized. Limit of system calls is reached or subscription is expired.
🔴500Server side issue. Server may respond with the details in response body.
Modified at 2022-09-10 18:38:13
Previous
Update queries
Next
Retrieve API status
Built with