Get a time-aggregated dataset

Get a time-aggregated dataset.

POST

https://api.textreveal.com/api/2.0/analyze/timeserie

Parameters

output_formatstring (enum)
The output format of the final timeseries.
Default: "json"Values: "json", "csv"

Request Body

instanceuuid
The identifier of an analysis. This identifier have to be used to get results.
Example: "a62caf56-5961-4fff-ba2e-6d4dcf98960f"
operands(string (enum))[]
Operands that will be used for aggregation.
Default: ["min", "max", "mean", "median"]Values: "min", "max", "mean", "median"
pivots(string (enum))[]
Additional pivots (groups) to the date.
Default: ["extract_day", "entity"]Values: "extract_day", "language", "entity", "site", "site_type", "country"
time_granularitystring (enum)
Aggregation granularity period. Available options are 'day', 'hour', 'minute'
Default: "day"Values: "day", "hour", "minute"
volume_onlyboolean
Aggregation mode. Set to true to display only volumes
Default: falseExample: false

Request

{
  "instance": "a62caf56-5961-4fff-ba2e-6d4dcf98960f",
  "operands": [
    "min",
    "max",
    "mean",
    "median"
  ],
  "pivots": [
    "extract_day",
    "language",
    "entity"
  ],
  "time_granularity": "day",
  "volume_only": false
}

Response - 200

A timestamped array with custom indicators

[]array

Response

[
  {
    "entity": "Q312",
    "extract_day": "2019-01-31",
    "language": "english",
    "max_anger": 0.97567480802536,
    "max_anticipation": 0.997955322265625,
    "max_fear": 0.927425265312195,
    "max_joy": 0.972901284694672,
    "max_negative": 0.998439133167267,
    "max_neutral": 0.906281650066376,
    "max_polarity": 0.906281650066376,
    "max_polarity_exp": 0.906281650066376,
    "max_positive": 0.983933985233307,
    "max_sadness": 0.697191715240479,
    "max_similarity": 0.921769022941589,
    "max_surprise": 0.909987330436707,
    "max_trust": 0.935355007648468,
    "mean_anger": 0.01101237116381525,
    "mean_anticipation": 0.3040662854909895,
    "mean_fear": 0.03092878218740225,
    "mean_joy": 0.100903607904911,
    "mean_negative": 0.2301826626062395,
    "mean_neutral": 0.23240802437066999,
    "mean_polarity": 0.906281650066376,
    "mean_polarity_exp": 0.906281650066376,
    "mean_positive": 0.3989255130290985,
    "mean_sadness": 0.009851101320236921,
    "mean_similarity": 0.808631002902985,
    "mean_surprise": 0.105088770389557,
    "mean_trust": 0.009034462738782171,
    "median_anger": 0.01101237116381525,
    "median_anticipation": 0.000404581107432023,
    "median_fear": 0.0000235419702221407,
    "median_joy": 0.0000282806922768941,
    "median_negative": 0.00179653591476381,
    "median_neutral": 0.275751342301376,
    "median_polarity": 0.906281650066376,
    "median_polarity_exp": 0.906281650066376,
    "median_positive": 0.000709029322024435,
    "median_sadness": 0.0000036597332382371,
    "median_similarity": 0.435824006795883,
    "median_surprise": 0.000322958512697369,
    "median_trust": 0.00000442326472693821,
    "min_anger": 0.06759066995771626,
    "min_anticipation": 0.37092805846023064,
    "min_fear": 0.09964104027673068,
    "min_joy": 0.20399669290784975,
    "min_negative": 0.30423797404026565,
    "min_neutral": 0.000851819233503193,
    "min_polarity": 0.000851819233503193,
    "min_polarity_exp": 0.000851819233503193,
    "min_positive": 0.4200106841461165,
    "min_sadness": 0.030234827427965343,
    "min_similarity": 0.8036714136546748,
    "min_surprise": 0.17218985858457217,
    "min_trust": 0.055418850662423254,
    "volume_document": 481,
    "volume_sentence": 19502
  }
]

Response - 202

The instance is still in progress. Retry later.

Response - 204

No content. The instance has been stopped or an error occured within the instance.