Semantria
  1. Subscription
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
  • Status
    • Retrieve API status
  • Subscription
    • Retrieve subscription details
      GET
  • Taxonomy
    • Remove taxonomy nodes
    • Retrieve taxonomy
    • Add taxonomy nodes
    • Update taxonomy nodes
  1. Subscription

Retrieve subscription details

GET
/subscription.{content_type}
This method retrieves user's subscription details that consist of the list of allowed features, configured limits and options on Semantria side.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.semantria.com//subscription.'
Response Response Example
200 - Example 1
{
    "basic_settings": {
        "auto_response_limit": 0,
        "batch_limit": 0,
        "blacklist_limit": 0,
        "callback_batch_limit": 0,
        "categories_limit": 0,
        "category_samples_limit": 0,
        "characters_limit": 0,
        "collection_limit": 0,
        "configurations_limit": 0,
        "entities_limit": 0,
        "output_data_limit": 0,
        "processed_batch_limit": 0,
        "queries_limit": 0,
        "return_source_text": true,
        "sentiment_limit": 0
    },
    "billing_settings": {
        "app_seats_allocated": 0,
        "app_seats_permitted": 0,
        "data_calls_balance": 0,
        "data_calls_limit": 0,
        "data_calls_limit_interval": 0,
        "docs_balance": 0,
        "docs_limit": 0,
        "docs_limit_interval": 0,
        "docs_suggested": 0,
        "docs_suggested_interval": 0,
        "expiration_date": "string",
        "limit_type": "string",
        "polling_calls_balance": 0,
        "polling_calls_limit": 0,
        "polling_calls_limit_interval": 0,
        "priority": "string",
        "settings_calls_balance": 0,
        "settings_calls_limit": 0,
        "settings_calls_limit_interval": 0
    },
    "feature_settings": {
        "collection": {
            "concept_topics": true,
            "facets": true,
            "mentions": true,
            "named_entities": true,
            "query_topics": true,
            "themes": true,
            "user_entities": true
        },
        "document": {
            "auto_categories": true,
            "concept_topics": true,
            "entity_themes": true,
            "intentions": true,
            "language_detection": true,
            "mentions": true,
            "model_sentiment": true,
            "named_entities": true,
            "named_relations": true,
            "opinions": true,
            "phrases_detection": true,
            "pos_tagging": true,
            "query_topics": true,
            "sentiment_phrases": true,
            "summary": true,
            "themes": true,
            "user_entities": true,
            "user_relations": true
        },
        "html_processing": true,
        "supported_languages": "string",
        "templates": {
            "config_id": "string",
            "description": "string",
            "id": "string",
            "is_free": true,
            "language": "string",
            "name": "string",
            "type": "language-default",
            "version": "string"
        }
    },
    "name": "string",
    "status": "string"
}

Request

Path Params
content_type
string 
required

Responses

🟢200Client request accepted and queued. Server responds with subscription details.
application/json
Body
basic_settings
object (SubscriptionBasicSection) 
required
auto_response_limit
integer 
required
Represents the maximum size of outgoing batch for auto-response feature
>= 0
batch_limit
integer 
required
Represents the maximum size of the incoming batch in documents
>= 0
blacklist_limit
integer 
required
Represents the maximum number of allowed blacklist items
>= 0
callback_batch_limit
integer 
required
Represents the maximum size of outgoing batch for callback data retrieving mode
>= 0
categories_limit
integer 
required
Represents the maximum number of allowed categories
>= 0
category_samples_limit
integer 
required
Represents the maximum number of allowed category samples
>= 0
characters_limit
integer 
required
Represents the maximum length of the document allowed for processing
>= 0
collection_limit
integer 
required
Represents the maximum size of collection in documents
>= 0
configurations_limit
integer 
required
Represents the maximum number of allowed configurations
>= 0
entities_limit
integer 
required
Represents the maximum number of allowed entities
>= 0
output_data_limit
integer 
required
Represent the maximum number allowed as output limit of configuration
>= 0
processed_batch_limit
integer 
required
Represents the maximum size of outgoing batch for pulling data retrieving mode
>= 0
queries_limit
integer 
required
Represents the maximum number of allowed queries
>= 0
return_source_text
boolean 
required
Indicates whether responding of source text along with the analysis data is allowed or not
sentiment_limit
integer 
required
Represents the maximum number of allowed sentiment-bearing phrases
>= 0
billing_settings
object (SubscriptionBillingSection) 
required
app_seats_allocated
integer 
required
Number of allocated application cells permitted to work with the API
>= 0
app_seats_permitted
integer 
required
Number of permitted application to work with the same API account
>= 0
data_calls_balance
integer 
required
Represents actual value of remained data API calls
>= 0
data_calls_limit
integer 
required
Represents the limit of data API calls per "data_calls_limit_interval" value
>= 0
data_calls_limit_interval
integer 
required
Represents an interval for the "data_calls_limit" value of current subscription
>= 0
docs_balance
integer 
required
Current transaction balance. Applicable for pay-as-you-go subscriptions only
>= 0
docs_limit
integer 
required
Represents the transactions limit per "docs_limit_interval" value
>= 0
docs_limit_interval
integer 
required
Represents the timeframe for the "docs_limit" value of current subscription
>= 0
docs_suggested
integer 
required
Represents the amount of favorable documents suggested for throughput subscriptions
>= 0
docs_suggested_interval
integer 
required
Represents the timeframe for the “docs_suggested” value of the current subscription
>= 0
expiration_date
string 
required
Expiration date of current subscription. Defined as a Unix time stamp
limit_type
string 
required
Subscription type can have either pay-as-you-go or throughput value
polling_calls_balance
integer 
required
Represents actual value of remained polling API calls
>= 0
polling_calls_limit
integer 
required
Represents the limit of polling API calls per "polling_calls_limit_interval" value
>= 0
polling_calls_limit_interval
integer 
required
Represents an interval for the "polling_calls_limit" value of current subscription
>= 0
priority
string 
required
Processing priority of current subscriber. Can have low, normal or high value
settings_calls_balance
integer 
required
Represents actual value of remained settings API calls
>= 0
settings_calls_limit
integer 
required
Represents the limit of settings API calls per "settings_calls_limit_interval" value
>= 0
settings_calls_limit_interval
integer 
required
Represents an interval for the "settings_calls_limit" value of current subscription
>= 0
feature_settings
object (SubscriptionFeatureSection) 
required
collection
object (SubscriptionFeatureSectionCollection) 
required
document
object (SubscriptionFeatureSectionDocument) 
required
html_processing
boolean 
required
Identifies whether HTML processing feature is supported or not
supported_languages
string 
required
Lists all languages which are allowed for current subscription
templates
object (SubscriptionFeatureSectionTemplate) 
required
name
string 
required
Semantria subscriber name. Usually email
status
string 
required
Semantria subscriber status. Can be active, expired, disabled, etc
🟠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
Retrieve API status
Next
Remove taxonomy nodes
Built with