Integr8 API Documentation (1)

The API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

All requests to the API must be authenticated using an API key. To authenticate, add a API-KEY header to your request that contains your API Key.

• For network administrators you can create individual API keys and find your API keys under Organization > API Access.
• For all users you can use your own API key by going to Profile > Security > Enable API Access.

We use conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a wrong data type is provided to a json field). Codes in the 5xx range indicate an error with our servers (these are rare).

To filter the result you can use the filter query parameter. Format:

filter[field_name][operator] = value

• field_name - is the field or property name. To filter a property within an object use dots such as filter[outer_field.inner_field]
• operator - the operators used. If omitted, the default operator is eq.

You can sort the result by adding sort query params like sort=-type,name. - will act for descending

The API in general is using numbered pages except for Reports.

To paginate the result you can provide the following:

• page[number] is the number of the page.
• page[size] is the size of the page. The API max limit is 100.

In the response, meta.total_count shows the number of total objects and meta.total_page shows the number of total pages.

{
  "meta": {
    "total_count": 1000,
    "total_page": 50
  }
}

Example:

Go to the first page:

GET /api/v2/coffees?page[size]=100&page[number]=1

Go to the second page:

GET /api/v2/coffees?page[size]=100&page[number]=2

Manage users within your organization. Create, read, update, and delete users and assign roles such as Account Manager.

Manage Offers

Manage Publishers

Manage Advertisers

Manage Offer Events (conversion goals) attached to an offer.