BEbeyondwords
Billing analytics

Organization billing analytics

Changed on

Retrieves billing analytics for all projects within an organization

get/organization/billing_analytics

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/organization/billing_analytics
  • Auth
    API key in header X-Api-Key

Query parameters

aggregation'all' | 'hour' | 'day' | 'week' | 'month' | 'year' | 'credit_cycle'
      The way to aggregate the analytics. Possible values are all (aggregate all data together),
      year (aggregate data on a yearly basis), month (aggregate data on a yearly basis),
      week (aggregate data on a yearly basis), day (aggregate data on a yearly basis), or hour
      (aggregate data on an hourly basis, limited to a time_range 7 days or less).
time_range[start]string

The start date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601.

time_range[end]string

The end date of the aggregation period. The value of this property should be a string in the format yyyy-mm-dd according to ISO 8601. If this is set to today, the current day is still in progress and therefore only partial analytics data is returned until the day ends.

event_type'content' | 'characters' | 'articles_credits' | 'credits' | 'total_characters'
entity_type'podcast' | 'video'
group_by[]string[]
filter[project_ids][]integer[]
filter[voice_ids][]integer[]
filter[content_ids][]string[]
filter[source_ids][]string[]

Response

OK

Changes