Skip to content

Requests

Parameters

Path Parameters

In all requests, {billing_plan} and {account_id} Path Parameters will always be required.
Other Path Parameters in a request will often be obtained from another endpoint response that will be indicated for each case.

Billing Plan

For all calls, it is required to specify the Billing Plan in the endpoint for which the API usage is granted.
Fixed value for {billing_plan} is the following:

  • ondemand

Therefore, each call will have the following pattern:

Template 
curl 'https://api.datappeal.io/v4/ondemand/account/{account_id}/…' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Header and Query Parameters

Nullability

The required Header and Query Parameters will be marked with * before the parameter name, while optional parameters will not be marked.

Dependency

A dependent Header and Query Parameter is marked with ⊢ to indicate that it can be set only if immediately previous parameter is set.
Text indentation is used to more clearly show the dependency hierarchy.

Deprecation

Deprecated Header and Query Parameters will be strikethrough and marked with , which means that is highly recommended not to use that parameter as it will be removed soon.
Corresponding replacing fields will be marked with .

Multi-value

Query Parameters marked with ⓝ can be repeated and set with a different value each time in order to be set with multiple values.

Pagination

When specified in the endpoint documentation, results can be paginated specifying page and page_size Query Parameters, which will always have implicit default values.

Request Body

Similarly to Request Parameters, in Request Body JSON object descriptions, required fields will be marked with * before the field name, while optional fields will not be marked.