subscriptions

Forager public API (1.0.0)

Forager public API endpoints documentation

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api-v2.forager.ai/

datastorage

Operations

organizations

Operations

persons

Operations

subscriptions

Operations

Credit Balance Change Log

Request

CreditsBalanceChangeLog list view.

Path
account_idintegerrequired
Query
date_created_endstring(date-time)
date_created_startstring(date-time)
pageinteger

A page number within the paginated result set.

curl -i -X GET \
  'https://api-v2.forager.ai/api/{account_id}/subscriptions/balance_change_logs/?date_created_end=2019-08-24T14%3A15%3A22Z&date_created_start=2019-08-24T14%3A15%3A22Z&page=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countinteger
Example: 15
nextinteger or null
Example: 2
previousinteger or null
Example: null
resultsArray of objects(CreditsBalanceChangeLog)
Response
application/json
{
  "count": 15,
  "next": 2,
  "previous": null,
  "results": [
    { … }
  ]
}

Credit Consumption Totals

Request

Calculate the total of credits spent during the specified timeframe.

Path
account_idintegerrequired
Query
date_created_endstring(date-time)
date_created_startstring(date-time)
curl -i -X GET \
  'https://api-v2.forager.ai/api/{account_id}/subscriptions/balance_change_logs/totals/?date_created_end=2019-08-24T14%3A15%3A22Z&date_created_start=2019-08-24T14%3A15%3A22Z' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
total_credits_spentintegerrequired
Response
application/json
{
  "total_credits_spent": 0
}

api_keys

Operations

users

Operations

objects-lookups

Operations