Ocamba API - 2.1.58

Ocamba REST description

Account-contacts

Get contacts 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/contacts
account_id
string
(required)		Unique account identifier defined as a path parameter.
Responses

total
integer
items
Response examples

{
  "total": 3,
  "items": [
    {
      "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
      "type": "email",
      "value": "[email protected]"
    }
  ]
}

Create contact 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/contacts
account_id
string
(required)		Unique account identifier defined as a path parameter.

Request examples

{
  "type": "email",
  "value": "[email protected]"
}

Responses

Response examples

{
  "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
  "type": "email",
  "value": "[email protected]"
}

Get contact 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/contacts/{id}
account_id
string
(required)		Unique account identifier defined as a path parameter.
id
string
(required)		Unique identifier defined as a path parameter.
Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
    {
      "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
      "type": "email",
      "value": "[email protected]"
    }
  ]
}

Update contact 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/contacts/{id}
account_id
string
(required)		Unique account identifier defined as a path parameter.
id
string
(required)		Unique identifier defined as a path parameter.

Request examples

{
  "type": "email",
  "value": "[email protected]"
}

Responses

At least one of the updatable fields should be sent via HTTP body in order to change the current state of the account.

Delete contact 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/contacts/{id}
account_id
string
(required)		Unique account identifier defined as a path parameter.
id
string
(required)		Unique identifier defined as a path parameter.
Responses

We recommend you consider other options before deletion

Account-limits

Get a collection of account limits 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/limits

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique identifier for the object defined as a query parameter.
type
string
Describe type of the object.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
item
string
period
string
Describe the period of the limit.
value
integer
Value of the upper limit.
account_id
string
(required)		Unique account identifier defined as a path parameter.

Responses

total
integer
items
Response examples

{
  "total": 3,
  "items": [
    {
      "id": "1000",
      "company_id": "1000001",
      "account_id": "1000000",
      "type": "budget",
      "item": "income",
      "period": "day",
      "value": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

Sortable fields are: account_id, period, value, create_time and update_time.

Create account limit 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/limits
account_id
string
(required)		Unique account identifier defined as a path parameter.

Request examples

{
  "type": "budget",
  "item": "income",
  "period": "day",
  "value": 1
}

Responses

Response examples

{
  "id": "1000",
  "company_id": "1000001",
  "account_id": "1000000",
  "type": "budget",
  "item": "income",
  "period": "day",
  "value": 1,
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}

Unique constraint is defined on a combination of the following fields: type, item and period. If you try to create two AccountLimit objects with same values on this combination of fields, the second object will be considered as Duplicate entry and your request will be rejected.

Get an instance of account limit 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/limits/{id}

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique identifier for the object defined as a path parameter.
account_id
string
(required)		Unique account identifier defined as a path parameter.

Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
    {
      "id": "1000",
      "company_id": "1000001",
      "account_id": "1000000",
      "type": "budget",
      "item": "income",
      "period": "day",
      "value": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

Update account limit 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/limits/{id}
id
string
(required)		Unique identifier for the object defined as a path parameter.
account_id
string
(required)		Unique account identifier defined as a path parameter.

Request examples

{
    "value":123
}

Responses

At least one of the updatable fields should be sent via HTTP body in order to change the current state of the account limit.

Delete account limit 

                https://api.ocamba.com/v2/ocamba/accounts/{account_id}/limits/{id}
id
string
(required)		Unique identifier for the object defined as a path parameter.
account_id
string
(required)		Unique account identifier defined as a path parameter.
Responses

This change will be automatically synchronized to an ad server.

We recommend you consider other options before deletion.

Accounts

Get a collection of accounts 

                https://api.ocamba.com/v2/ocamba/accounts

Displays account contacts details

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique account id.
status
string
Displays current status of the account
name
string
Name of the account.
update_time
string
Timezone: GMT.
create_time
string
Timezone: GMT.
Responses

total
integer
items
Response examples

{
  "total": 3,
  "items": [
    {
      "id": "1000000",
      "company_id": "1000001",
      "creator_id": "1000001",
      "status": "active",
      "ssp_configuration": {
        "advertiser": "enabled",
        "publisher": "disabled"
      },
      "configured_status": "active",
      "name": "Demo account",
      "image": "https://storage.ocamba.com/1000001/adex/accounts/1000000/account.jpeg",
      "contacts": [
        {
          "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
          "type": "email",
          "value": "[email protected]"
        }
      ],
      "feeds": {
        "postbacks": "https://google.com"
      },
      "is_default": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

Searchable field is name.

Sortable fields are: creator_id, status, name, is_default, create_time and update_time.

Create an instance of account 

                https://api.ocamba.com/v2/ocamba/accounts

Allows creation of an account.

Request examples

{
  "status": "active",
  "ssp_configuration": {
    "advertiser": "enabled",
    "publisher": "disabled"
  },
  "name": "Demo account",
  "contacts": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "feeds": {
    "postbacks": "https://google.com"
  }
}

Responses

Response examples

{
  "id": "1000000",
  "company_id": "1000001",
  "creator_id": "1000001",
  "status": "active",
  "ssp_configuration": {
    "advertiser": "enabled",
    "publisher": "disabled"
  },
  "configured_status": "active",
  "name": "Demo account",
  "image": "https://storage.ocamba.com/1000001/adex/accounts/1000000/account.jpeg",
  "contacts": [
    {
      "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "feeds": {
    "postbacks": "https://google.com"
  },
  "is_default": 1,
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}

Get an instance of account 

                https://api.ocamba.com/v2/ocamba/accounts/{id}

Returns the details of the account with the specified id

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique account id.

Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
    {
      "id": "1000000",
      "company_id": "1000001",
      "creator_id": "1000001",
      "status": "active",
      "ssp_configuration": {
        "advertiser": "enabled",
        "publisher": "disabled"
      },
      "configured_status": "active",
      "name": "Demo account",
      "image": "https://storage.ocamba.com/1000001/adex/accounts/1000000/account.jpeg",
      "contacts": [
        {
          "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
          "type": "email",
          "value": "[email protected]"
        }
      ],
      "feeds": {
        "postbacks": "https://google.com"
      },
      "is_default": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

If you don’t know the account id, list the accounts to find it.

Update an instance of account 

                https://api.ocamba.com/v2/ocamba/accounts/{id}

Updates the details of the account with the specified id.

id
string
(required)		Unique account id.

Request examples

{
  "status": "active",
  "ssp_configuration": {
    "advertiser": "enabled",
    "publisher": "disabled"
  },
  "name": "Demo account",
  "contacts": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "feeds": {
    "postbacks": "https://google.com"
  }
}

Responses

At least one of the updatable fields should be sent via HTTP body in order to change the current state of the account.

If you don’t know the account id, list the account to find it.

Delete an instance of account 

                https://api.ocamba.com/v2/ocamba/accounts/{id}

Deletes the account with the specified id.

id
string
(required)		Unique account id.
Responses

You can not delete account which is already in use.

This change will be automatically synchronized to an ad server.

We recommend you consider other options before deletion.

If you don’t know the account id, list the accounts to find it.

Upload account image 

                https://api.ocamba.com/v2/ocamba/accounts/{id}/image

Uploads the image for the account with specified id

id
string
(required)		Unique account id.
Request examples

--form 'image=@"logo.jpeg"'
Responses

Delete account image 

                https://api.ocamba.com/v2/ocamba/accounts/{id}/image

Deletes the image for the account with specified id

id
string
(required)		Unique account id.
Responses

App-store

Get a collection of apps available on App Store 

                https://api.ocamba.com/v2/ocamba/app-store
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique identifier for the object defined as a query parameter.
title
string
Title of the object.
type
string
Describe type of the object.
name
string
Name of the object.
status
string
Describe status of the object.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
is_published
integer
Describe publish status.
Responses

total
integer
items
Response examples

{
  "total": 2,
  "items": [
    {
      "id": "1001",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "logo": "https://sm.ocmcore.com/share/6197120/ocamba/apps/adex/logo/adex.svg",
      "description": "Ocamba AdExchange is an automated bidding system with full machine learning for maximum efficiency in Ad campaign management.  It allows you to have full control over Ad display, with advanced targeting and statistics to improve and manage your campaign performance with ease. ",
      "published_version": "1.0.1",
      "rc_version": "2.0.28",
      "status": "active",
      "installed_version": "2.0.28",
      "create_time": "2021-02-17 15:29:25",
      "update_time": "2021-07-20 12:17:09"
    },
    {
      "id": "1005",
      "type": "application",
      "title": "Lorem Ipsum",
      "name": "loremipsum",
      "logo": "https://cdn2.iconfinder.com/data/icons/advertising-agency-malibu-vol-2/128/Open_Exchange-512.png",
      "description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages.",
      "published_version": "1.0.8",
      "rc_version": "1.0.9",
      "status": "uninstalled",
      "installed_version": "1.0.9",
      "create_time": "2021-03-05 12:27:18",
      "update_time": "2021-04-13 13:48:06"
    }
  ] 
}


{
  "items": [
    {
      "id": "123456789",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "description": "here goes description",
      "logo": "https://logo-uri-example.com",
      "published_version": "1.0.10",
      "rc_version": "2.0.1",
      "status": "trial",
      "installed_version": "2.0.28",
      "create_time": "2021-11-25 13:45:03",
      "update_time": "2021-11-26 11:37:25"
    }
  ]
}

Searchable fields are: title, description, rc_version and published_version.

Sortable fields are: id, type, title, name, create_time and update_time.

Retrieve an app 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}

id
string
(required)		Unique identifier for the object defined as a path parameter.
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.

Responses

total
integer
items
Response examples

{
      "total": 1,
      "items": [
        {
          "id": "1003",
          "type": "application",
          "title": "Push App",
          "name": "push",
          "logo": "https://sm.ocmcore.com/share/6197120/ocamba/apps/push/logo/push.svg",
          "description": "Ocamba Push allows you to deliver personalized push notifications to your audience. Fully customize your content, stimulate user engagement with real-time updates, promotions, or reminders, boost conversion rates, and increase traffic on your mobile app or website.",
          "published_version": "1.0.0",
          "rc_version": "2.0.16",
          "status": "trial",
          "installed_version": "2.0.16",
          "create_time": "2021-03-03 09:29:18",
          "update_time": "2021-07-20 12:17:09"
        }
      ]
    }


{
  "items": [
    {
      "id": "123456789",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "description": "here goes description",
      "logo": "https://logo-uri-example.com",
      "published_version": "1.0.10",
      "rc_version": "2.0.1",
      "status": "trial",
      "installed_version": "2.0.28",
      "create_time": "2021-11-25 13:45:03",
      "update_time": "2021-11-26 11:37:25"
    }
  ]
}

If you don’t know the app id, list the members to find it.

Get an app pricing details 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}/pricing

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
type
string
Describe type of the object.
name
string
Name of the object.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
plan
string
id
string
(required)		Unique identifier for the object defined as a path parameter.

Responses

total
integer
items
Response examples

{
  "total": 4,
  "items": [
     {
       "plan": "enterprise",
       "app_id": "1003",
       "type": "deal",
       "name": "ENTERPRISE",
       "base": "business",
       "components": {
           "contact_us": [
             {
               "name": "contact us"
             }
           ],
           "features": [
             {
               "name": "Unlimited Apps"
             },
             {
               "name": "Custom Audience Segments"
             },
             {
               "name": "Custom User Data"
             },
             {
               "name": "Full Onboarding"
             },
             {
               "name": "White label domains"
             },
             {
               "name": "Self Serving Platform"
             },
             {
               "name": "Dedicated Account Manager"
             },
             {
               "name": "Integration Engineer Support"
             }
           ],
           "plan_info": [
             {
               "limit": "Over 500K Subscribers"
             }
           ]
         }
     }
  ]
}


{
  "items": [
    {
      "id": "123456789",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "description": "here goes description",
      "logo": "https://logo-uri-example.com",
      "published_version": "1.0.10",
      "rc_version": "2.0.1",
      "status": "trial",
      "installed_version": "2.0.28",
      "create_time": "2021-11-25 13:45:03",
      "update_time": "2021-11-26 11:37:25"
    }
  ]
}

If you don’t know the app id, list apps to find it.

Install an app 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}/install
id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

Uninstall an app 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}/uninstall
id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

Update an instance of app 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}/update
id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

Buy an app 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}/buy
id
string
(required)		Unique identifier for the object defined as a path parameter.
Request examples

{
  "plan": "business",
  "recurring_charge": "mrc",
  "payment":{
      "id": "6KH22796H07396938",
      "provider": "paypal" 
  }
}
Responses

Upgrade an app 

                https://api.ocamba.com/v2/ocamba/app-store/{app_id}/upgrade
id
string
(required)		Unique identifier for the object defined as a path parameter.
Request examples

{
  "plan": "business",
  "recurring_charge": "mrc",
  "payment":{
      "id": "6KH22796H07396938",
      "provider": "paypal" 
  }
}
Responses

Apps

Get a collection of apps 

                https://api.ocamba.com/v2/ocamba/apps
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique identifier for the object defined as a query parameter.
name
string
Name of the object.
title
string
Title of the object.
type
string
Describe type of the object.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
Responses

total
number
items
Response examples

{
    "total": 7,
    "items": [
        {
            "id": "1018",
            "type": "application",
            "title": "developer",
            "name": "developer",
            "create_time": "2021-10-08 11:42:48",
            "update_time": "2021-11-15 09:43:31"
        },
        {
            "id": "1017",
            "type": "application",
            "title": "demoapp",
            "name": "demoapp",
            "create_time": "2021-10-08 11:27:31",
            "update_time": "2021-11-15 08:10:49"
        },
        {
            "id": "1016",
            "type": "application",
            "title": "finance",
            "name": "finance",
            "create_time": "2021-10-08 10:00:25",
            "update_time": "2021-10-08 10:04:41"
        }
    ]
}


{
  "items": [
    {
      "id": "123456789",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "description": "here goes description",
      "logo": "https://logo-uri-example.com",
      "plan": "'{ \n   \"features\" : [\"billing\"]\n }'",
      "create_time": "2021-11-25 13:45:03",
      "update_time": "2021-11-26 11:37:25"
    }
  ]
}

Searchable fields are title and description.

Sortable fields are: id, type, title, name, create_time and update_time.

Get an instance of app 

                https://api.ocamba.com/v2/ocamba/apps/{id}

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique identifier for the object defined as a path parameter.

Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
      {
          "id": "1003",
          "type": "application",
          "title": "Push App",
          "name": "push",
          "description": "Ocamba Push allows you to deliver personalized push notifications to your audience. Fully customize your content, stimulate user engagement with real-time updates, promotions, or reminders, boost conversion rates, and increase traffic on your mobile app or website.",
          "logo": "https://sm.ocmcore.com/share/6197120/ocamba/apps/push/logo/push.svg",
          "create_time": "2021-03-03 09:29:18",
          "update_time": "2021-07-20 12:17:09"
      }
  ]
}


{
  "items": [
    {
      "id": "123456789",
      "type": "application",
      "title": "AdExchange",
      "name": "adex",
      "description": "here goes description",
      "logo": "https://logo-uri-example.com",
      "plan": "'{ \n   \"features\" : [\"billing\"]\n }'",
      "create_time": "2021-11-25 13:45:03",
      "update_time": "2021-11-26 11:37:25"
    }
  ]
}

If you don’t know the app id, list the apps to find it.

Get a collection of app members 

                https://api.ocamba.com/v2/ocamba/apps/{id}/members

id
string
(required)		Unique identifier for the object defined as a path parameter.
name
string
Name of the object.
status
string
Describe status of the object.
email
string
Email which is being used for a object.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Responses

total
integer
items
Response examples

{
  "total": 2,
  "items": [
    {
      "id": "1234567",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    },
    {
      "id": "7654321",
      "name": "Jane Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2020-08-28 11:29:48",
      "update_time": "2021-04-15 17:13:59"
    }
  ]
}


{
  "items": [
    {
      "id": "1000163",
      "company_id": "1000000",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://image-uri-example.com",
      "preferences": {},
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Sortable fields are create_time and update_time.

Add or remove an app member 

                https://api.ocamba.com/v2/ocamba/apps/{id}/members
Request examples

{
  "add": ["1234567", "7654321"]
}


{
  "remove": ["7654321"]
}
Responses

Automations

Get a collection of automations 

                https://api.ocamba.com/v2/ocamba/ebs/automations
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
Responses

Response examples

{
    "total":1,
    "items":[
        {
            "id":"10001",
            "company_id":"6197120",
            "status":"active",
            "name":"Push welcome",
            "description":"Push adex welcome notification",
            "event":{
                "id":"1000",
                "integration_id":"10000"
            },
            "actions":{
                "id":"1002",
                "integration_id":"10000",
                "data":{
                    "user_id":"{{event.user_id}}",
                    "zone_id":"12345678"
                }
            },
            "create_time":"2022-07-02 12:30:40",
            "update_time":"2022-07-05 13:19:10"
        }
    ]
}

Create an instance of an automation 

                https://api.ocamba.com/v2/ocamba/ebs/automations

Request examples

{
  "status":"active",
  "name":"Push welcome",
  "description":"Push adex welcome notification",
  "event":{
    "id":"1000",
    "integration_id":"10000"
  },
  "actions":{
    "id":"1002",
    "integration_id":"10000",
    "data":{
      "user_id":"{{event.user_id}}",
      "zone_id":"12345678"
    }
  }
}

Responses

Response examples

{
  "id":"11000",
  "company_id":"6197120",
  "status":"active",
  "name":"Push welcome",
  "description":"Push adex welcome notification",
  "event":{
    "id":"1000",
    "integration_id":"10000"
  },
  "actions":{
    "id":"1002",
    "integration_id":"10000",
    "data":{
      "user_id":"{{event.user_id}}",
      "zone_id":"12345678"
    }
  },
  "create_time":"2022-07-02 12:30:40",
  "update_time":"2022-07-05 13:19:10"
}

Get an instance of an automation 

                https://api.ocamba.com/v2/ocamba/ebs/automations/{id}

Show details for an automation, by provided ID.

view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique identifier for the object defined as a path parameter.

Responses

Response examples

{
    "total":1,
    "items":[
        {
            "id":"10001",
            "company_id":"6197120",
            "status":"active",
            "name":"Push welcome",
            "description":"Push adex welcome notification",
            "event":{
                "id":"1000",
                "integration_id":"10000"
            },
            "actions":{
                "id":"1002",
                "integration_id":"10000",
                "data":{
                    "user_id":"{{event.user_id}}",
                    "zone_id":"12345678"
                }
            },
            "create_time":"2022-07-02 12:30:40",
            "update_time":"2022-07-05 13:19:10"
        }
    ]
}

If you don’t know the automation id, list the automations to find it.

Partialy update an automation 

                https://api.ocamba.com/v2/ocamba/ebs/automations/{id}
id
string
(required)		Unique identifier for the object defined as a path parameter.
Request examples

{
  "status":"inactive",
  "name":"Push welcome",
  "event":{
    "id":"1000",
    "integration_id":"10000"
  }
}
Responses

Delete an automation 

                https://api.ocamba.com/v2/ocamba/ebs/automations/{id}
id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

If you don’t know the automation id, list the automations to find it.

Autonomous-systems

Get a collection of autonomus systems details 

                https://api.ocamba.com/v2/ocamba/autonomous-system

The read-only autonomous-system Service provides details about the ASN and ASO (autonomous system number and autonomous system organization) for IP addresses

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique ASN - autonomous system number
asn
integer
ASN - autonomous system number
aso
integer
ASO - autonomous system organization
isp
string
Name of the Internet service provider.
organization
integer
Name of the organization
Responses

total
integer
items
Response examples

{
    "total": 70819,
    "items": [
        {
          "id": "55734",
          "asn": 55734,
          "aso": "001 IT Complex",
          "isp": "001 IT Complex",
          "organization": "001 IT Complex"
        },
        {
          "id": "60502",
          "asn": 60502,
          "aso": "01 System Srl",
          "isp": "01 System Srl",
          "organization": "01 System Srl"
        },
        {
          "id": "209288",
          "asn": 209288,
          "aso": "020 ICT",
          "isp": "020 ICT",
          "organization": "020 ICT"
        }
    ]
}


{
  "items": [
    {
      "id": "55734",
      "asn": 55734,
      "aso": "001 IT Complex",
      "isp": "001 IT Complex",
      "organization": "001 IT Complex"
    }
  ]
}

Searchable fields are: aso, isp and organization.

Sortable fields are: id, asn, aso, isp and organization.

Get information about autonomus system with specified id 

                https://api.ocamba.com/v2/ocamba/autonomous-system/{id}

The read-only autonomous-system Service provides details about the ASN and ASO (autonomous system number and autonomous system organization) for IP addresses when id (ASN) is specified

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
integer
(required)		Unique ASN - autonomous system number

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "55734",
          "asn": 55734,
          "aso": "001 IT Complex",
          "isp": "001 IT Complex",
          "organization": "001 IT Complex"
        }
    ]
}


{
  "items": [
    {
      "id": "55734",
      "asn": 55734,
      "aso": "001 IT Complex",
      "isp": "001 IT Complex",
      "organization": "001 IT Complex"
    }
  ]
}

If you don’t know the id, list the collection to find it.

Browsers

Get a collection of browsers 

                https://api.ocamba.com/v2/ocamba/browsers

The read-only Browsers Service allows you to see which browsers are registered in Ocamba. You can use this service to retrieve the id-s and names of browsers

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
name
integer
The name of the browser, example - Chrome.
id
integer
Unique browser id
Responses

total
integer
items
Response examples

{
    "total": 12,
    "items": [
        {
          "id": "72",
          "name": "Android"
        },
        {
          "id": "17",
          "name": "Edge"
        },
        {
          "id": "12",
          "name": "Chrome"
        }
    ]
}


{
  "items": [
    {
      "id": "12",
      "name": "Chrome",
      "versions": [
        {
          "id": "174",
          "name": "Chrome 10",
          "versions": "10.0"
        }
      ]
    }
  ]
}

Searchable field is name.

Sortable fields are id and name.

Get a browser 

                https://api.ocamba.com/v2/ocamba/browsers/{id}

The read-only Browsers service returns a browser name when id is specified

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
integer
(required)		Unique browser “id”

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "72",
          "name": "Android"
        }
    ]
}


{
  "items": [
    {
      "id": "12",
      "name": "Chrome",
      "versions": [
        {
          "id": "174",
          "name": "Chrome 10",
          "versions": "10.0"
        }
      ]
    }
  ]
}

If you don’t know the browser id, list the browsers to find it.

Cities

Get a collection of cities 

                https://api.ocamba.com/v2/ocamba/cities

The read-only City Service allows you to see information about the cities registered in Ocamba, including the name, region, country code, and country to which each city belongs.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
name
string
The name of the city.
id
string
Unique id of the city
region
string
The name of the region to which the city belongs. Example - British Columbia
country_code
string
The two-letter, uppercase ISO Code of the country to which the city belongs. Example - CA.
full_name
string
Full address
Responses

total
integer
items
Response examples

{
    "total": 168596,
    "items": [
        {
            "id": "5881639",
            "name": "100 Mile House",
            "region": "British Columbia",
            "country_code": "CA",
            "full_name": "100 Mile House, British Columbia, CA"
        },
        {
            "id": "3504833",
            "name": "12 de Haina",
            "region": "Nacional",
            "country_code": "DO",
            "full_name": "12 de Haina, Nacional, DO"
        },
        {
            "id": "8556282",
            "name": "150 Mile House",
            "region": "British Columbia",
            "country_code": "CA",
            "full_name": "150 Mile House, British Columbia, CA"
        }
    ]
}     


{
  "items": [
    {
      "id": "5881639",
      "country_code": "CA",
      "region": "British Columbia",
      "name": "100 Mile House",
      "full_name": "100 Mile House, British Columbia, CA"
    }
  ]
}

Searchable fields are: name, region and full_name.

Sortable fields are: id, region, country_code name and full_name.

Get a city 

                https://api.ocamba.com/v2/ocamba/cities/{id}

The read-only City service returns a name of the city when it’s id is specified.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
integer
(required)		Unique id of the city

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "5881639",
          "name": "100 Mile House",
          "region": "British Columbia",
          "country_code": "CA",
          "full_name": "100 Mile House, British Columbia, CA"
        }
    ]
} 


{
  "items": [
    {
      "id": "5881639",
      "country_code": "CA",
      "region": "British Columbia",
      "name": "100 Mile House",
      "full_name": "100 Mile House, British Columbia, CA"
    }
  ]
}

If you don’t know the city id, list the cities to find it.

Companies

Get a company 

                https://api.ocamba.com/v2/ocamba/company

Returns details of the Company registered in Ocamba.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
            "id": "1234567",
            "name": "Ocamba App",
            "short_name": "OAPP",
            "domain": "ocamba.app",
            "status": "active",
            "logo": "https://dev-storage.ocamba.com/1234567/ocamba/company/logo/mickey-mouse.jpg",
            "create_time": "2021-01-20T14:50:46Z",
            "update_time": "2021-10-29T14:02:37Z"
        }
    ]
}


{
  "items": [
    {
      "id": "1000163",
      "ownver_id": "10132163",
      "xero_id": "c13a387e-af72-475d-98ef-b03dfae8d750",
      "name": "Ocamba App",
      "short_name": "OAPP",
      "status": "active",
      "domain": "demo.app",
      "registration_number": "12345",
      "vat_id": "45",
      "logo": "https://path/logo.jpeg",
      "address": "Dragise Misovic 163b, Cacak, Serbia",
      "email": "[email protected]",
      "website": "https://www.google.com",
      "billing": {
        "email": "[email protected]",
        "address": {
          "street": "Dragise Misovica 163b",
          "city": "Cacak",
          "country": "RS",
          "postal_code": "32000"
        }
      },
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Update a company 

                https://api.ocamba.com/v2/ocamba/company

Edit the details of the registered Company.

Request examples

{
  "name": "DemoTest App",
  "short_name": "DTAPP",
  "address": "Vojvode Stepe 14, Cacak, Serbia",
  "website": "www.google.com"
}

Responses

At least one of the updatable fields should be sent via HTTP body in order to change the current state of the company.

If you don’t know the company id, list the companies to find it.

                https://api.ocamba.com/v2/ocamba/company/logo

Allows to set or update the logo of the company with specified id.

id
string
(required)		Unique identifier for the object defined as a path parameter.
Request examples

--form 'file=@"path/logo.jpeg"'
Responses

If you don’t know the company id, list the companies to find it.

                https://api.ocamba.com/v2/ocamba/company/logo

Allows to delete the logo of the company with specified id.

id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

This change will be automatically synchronized to an ad server.

We recommend you consider other options before deletion.

If you don’t know the company id, list the companies to find it.

Connection-types

Get a collection of connection-types 

                https://api.ocamba.com/v2/ocamba/connection-types

The read-only Connection-types Service allows you to see which internet connection types are registered in Ocamba. 

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique connection type id
name
integer
The name of the connection type. Example - cable/dsl, cellular, corporate, dialup, unknown
Responses

total
integer
items
Response examples

{
    "total": 5,
    "items": [
        {
            "id": "2",
            "name": "cable/dsl"
        },
        {
            "id": "4",
            "name": "cellular"
        },
        {
            "id": "3",
            "name": "corporate"
        },
        {
            "id": "1",
            "name": "dialup"
        },
        {
            "id": "0",
            "name": "unknown"
        }
    ]
}      


{
  "items": [
    {
      "id": "2",
      "name": "cable/dsl"
    }
  ]
}

Searchable field is name.

Sortable fields are name and id.

Get a connection-type 

                https://api.ocamba.com/v2/ocamba/connection-types/{id}

The read-only Connection-type Service returns internet connection type registered with specified id in Ocamba.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
integer
(required)		Unique id of the connection type

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "2",
          "name": "cable/dsl"
        }
    ]
} 


{
  "items": [
    {
      "id": "2",
      "name": "cable/dsl"
    }
  ]
}

If you don’t know the connection-type id, list the connection-types to find it.

Countries

Get a collection of countries 

                https://api.ocamba.com/v2/ocamba/countries

The read-only Countries Service allows you to see information about the countries registered in Ocamba.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
string
Unique id of the country.
name
string
The name of the country.
code
string
The two-letter, uppercase ISO Code of the country. Example - CA
code3
string
The three-letter, uppercase ISO country code. Example - AFG
Responses

total
integer
items
Response examples

{
    "total": 256,
    "items": [
        {
            "id": "AF",
            "code": "AF",
            "code3": "AFG",
            "name": "Afghanistan"
        },
        {
            "id": "AX",
            "code": "AX",
            "code3": "AXA",
            "name": "Aland Islands"
        },
        {
            "id": "DZ",
            "code": "DZ",
            "code3": "DZA",
            "name": "Algeria"
        }
    ]
}           


{
  "items": [
    {
      "id": "AF",
      "code": "AF",
      "code3": "AFG",
      "name": "Afghanistan"
    }
  ]
}

Searchable field is name.

Sortable fields are: name, code, code3 and id.

Get a country 

                https://api.ocamba.com/v2/ocamba/countries/{id}

The read-only Country Service returns the two-letter, uppercase ISO Code of the country with specified id. 

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string
(required)		Unique id of the country

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
            "id": "AF",
            "code": "AF",
            "code3": "AFG",
            "name": "Afghanistan"
        }
    ]
} 


{
  "items": [
    null
  ]
}

If you don’t know the country id, list the countries to find it.

Currencies

Get a collection of currencies 

                https://api.ocamba.com/v2/ocamba/currencies

The read-only Currencies service returns the list of usable currencies in Ocamba

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
string
Unique id of the currency. Example - CNY
name
string
The name of the currency. Example - Euro
code
string
Three-letter, uppercase currency code. Example - CNY
rate
number
Currency exchange rate. Example - 6.3848
Responses

total
integer
items
Response examples

{
    "total": 8,
    "items": [
        {
            "id": "CNY",
            "code": "CNY",
            "name": "Chinese Yuan Renminbi",
            "rate": 6.3848
        },
        {
            "id": "EUR",
            "code": "EUR",
            "name": "Euro",
            "rate": 0.88963
        },
        {
            "id": "ILS",
            "code": "ILS",
            "name": "Israeli Shekel",
            "rate": 3.09698
        }
    ]
}          


{
  "items": [
    {
      "id": "CNY",
      "code": "CNY",
      "name": "Chinese Yuan Renminbi",
      "rate": 6.3848
    }
  ]
}

Searchable field is name.

Sortable fields are: name, code, rate and id.

Get a currency 

                https://api.ocamba.com/v2/ocamba/currencies/{id}

The read-only Currency Service returns parameters of the country with specified id. 

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string
(required)		Unique id of the currency. Example - CNY

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
            "id": "CNY",
            "code": "CNY",
            "name": "Chinese Yuan Renminbi",
            "rate": 6.3848
        }
    ]
} 


{
  "items": [
    null
  ]
}

If you don’t know the currency id, list the currencies to find it.

Dashboards

Get a collection of dashboards 

                https://api.ocamba.com/v2/ocamba/dashboards
Responses

Create an instance of dashboard 

                https://api.ocamba.com/v2/ocamba/dashboards

Request examples

{
  "app_id": "1001",
  "name": "Activity dashboard",
  "description": "Displays user activity",
  "system": 1,
  "is_default": 1
}

Responses

Response examples

{
  "id": "295",
  "company_id": "6197120",
  "app_id": "1001",
  "ref": null,
  "creator_id": "1000077",
  "name": "Activity dashboard",
  "description": "Displays user activity"
}

Get an instance of dashboard 

                https://api.ocamba.com/v2/ocamba/dashboards/{id}

fields
string
When you retrieve a collection of some source, you can specify a subset of fields to be returned for each source. For efficiency, every source in a collection is represented by the default representation.
view
string
You can request one of the predefined representations(default, full) or custom representation according to your needs.
sort
string
The collection of accounts can be sorted by name, type, create_time, campaign_count and zone_count (ASC) is a default.
page
string
When you retrieve a collection of sources, pagination is enforced by default. If you don’t specify a value for the collection size, 10 is used as a default.
id
string
(required)		Unique identifier for the object defined as a path parameter.

Responses

Partialy update a dashboard. 

                https://api.ocamba.com/v2/ocamba/dashboards/{id}
id
string
(required)		Unique identifier for the object defined as a path parameter.

Request examples

{
  "app_id": "1001",
  "name": "Activity dashboard",
  "description": "Displays user activity",
  "system": 1,
  "is_default": 1
}

Responses

Deletes a dashboard, by provided ID. 

                https://api.ocamba.com/v2/ocamba/dashboards/{id}
id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

Pin dashboard 

                https://api.ocamba.com/v2/ocamba/dashboards/{id}/pin
id
string
(required)		Unique identifier for the object defined as a path parameter.
app_id
string
(required)		The ID of the application to which the dashboard will be pinned.
Responses

Replace all widgets in dashboard 

                https://api.ocamba.com/v2/ocamba/dashboards/{id}/widgets
id
string
(required)		Unique identifier for the object defined as a path parameter.
Request examples

[
    {
        "id": "42",
        "grid": {"h": 20,"w": 20,"x": 5, "y": 5}
    },
    {
        "id": "41",
        "grid": {"h": 10,"w": 10, "x": 10, "y": 10}
    }
]
Responses

Device-manufacturers

Get a collection of device-manufacturers 

                https://api.ocamba.com/v2/ocamba/device-manufacturers

The read-only device-manufacturers service returns the list of device manufacturers names specified in Ocamba.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
string
Unique id of the device manufacturer. Example - 14.
name
string
The name of the device manufacturer. Example - APPLE
Responses

total
integer
items
Response examples

{
    "total": 16,
    "items": [
        {
          "id": "14",
          "name": "APPLE"
        },
        {
          "id": "13",
          "name": "BLACKBERRY"
        },
        {
          "id": "1",
          "name": "Dell"
        }
    ]
}          


{
  "items": [
    {
      "id": "14",
      "name": "APPLE"
    }
  ]
}

Searchable field is name.

Sortable fields are name and id.

Get a device-manufacturer 

                https://api.ocamba.com/v2/ocamba/device-manufacturers/{id}

The read-only device-manufacturer service returns name of the device manufacturer with specified id. 

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string
(required)		Unique id of the device manufacturer. Example - 14.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "14",
          "name": "APPLE"
        }
    ]
} 


{
  "items": [
    {
      "id": "14",
      "name": "APPLE"
    }
  ]
}

If you don’t know the device-manufacture id, list the device-manufactures to find it.

Integrations

Get a collection of integrations 

                https://api.ocamba.com/v2/ocamba/event-system/integrations
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
Responses

Response examples

{
  "total": 1,
  "items": [
    {
      "id": "10000",
      "name": "Ocamba Hood",
      "description": "Hood app from Ocamba platform",
      "homepage": "https://ocamba.com",
      "version": "1.0.0",
      "audience": "public",
      "create_time": "2022-06-30 07:55:49",
      "update_time": "2022-06-30 07:55:49",
      "events": [
        {
          "id": "1000",
          "integration_id": "10000",
          "name": "Push subscription",
          "item": "Push",
          "description": "Triggers when user subscribes",
          "operation": {
            "output_params": [
                {
                    "key": "user_id",
                    "type": "string"
                }
                {
                    "key": "app_name",
                    "type": "string"
                },
                {
                    "key": "tag_id",
                    "type": "string"
                }
            ]
          },
          "create_time": "2022-06-30 08:23:34",
          "update_time": "2022-07-04 10:47:30"
        }
      ],
      "actions": [
        {
          "id": "1010",
          "integration_id": "10000",
          "name": "Send Adex notification",
          "item": "Push",
          "description": "Send webpush to a subscribed user on Ocamba hood tag",
          "engine": "api",
          "operation": {
            "input_params": {
                "user_id": {
                    "key": "User id",
                    "type": "string",
                    "description": "user from ocamba platform, use from event only",
                    "required": true,
                    "in": "body"
                },
                "zone_id": {
                    "key": "Zone id",
                    "type": "string",
                    "description": "Zone id from Ocamba adex",
                    "required": true,
                    "in": "body"
                }
              }
          },
          "create_time": "2022-06-30 08:25:18"
        }
      ]
    } 
  ] 
}

Get an instance of integration 

                https://api.ocamba.com/v2/ocamba/event-system/integrations/{id}

Show details for a integration, by provided ID.

id
string
(required)		Unique identifier for the object defined as a path parameter.
Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
    {
      "id": "10014",
      "name": "Integration",
      "description": "Description of integration",
      "logo": "https://www.google.com/search?q=logo&rlz=1C5CHFA_enRS985RS988",
      "homepage": "https://delsystems.net/index.htm",
      "version": "1.1.10",
      "audience": "public",
      "events": [
        {
          "id": "1026",
          "integration_id": "10002",
          "name": "Create Event",
          "item": "item",
          "description": "Creates a Event",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "actions": [
        {
          "id": "1014",
          "integration_id": "10014",
          "name": "Create Ticket",
          "item": "Ticket",
          "engine": "email",
          "properties": {
            "label": {
              "key": "url",
              "type": "string",
              "description": "design description",
              "required": true
            }
          },
          "description": "Creates a Ticket",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the integration id, list the integrations to find it.

Invite

Get a collection of invites 

                https://api.ocamba.com/v2/ocamba/invites

The Invites Service allows you to add Users to the Ocamba platform and manipulate the invitations.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique id of the invite.
status
string
Returns the status of the invite. May be Active, Pending, Expired
create_time
string
Time of the invite, in Etc/GMT timezone.
inviter_id
string
A unique id of the inviter.
invitee
string
Email address of the User invited to Ocamba platform.
invite_time
string
Inviting time, initial or subsequent, in Etc/GMT timezone.
message
string
Optional message sent to user invited to Ocamba.
Responses

total
integer
items
Response examples

{
    "total": 11,
    "items": [
        {
          "id": "293",
          "inviter_id": "1000125",
          "invitee": "[email protected]",
          "name": "John Doe",
          "status": "expired",
          "create_time": "2021-10-29 06:59:40"
        },
        {
          "id": "292",
          "inviter_id": "1000005",
          "invitee": "[email protected]",
          "name": "John Doe",
          "status": "expired",
          "create_time": "2021-10-29 06:57:35"
        },
        {
          "id": "291",
          "inviter_id": "1000034",
          "invitee": "[email protected]",
          "name": "John Doe",
          "status": "expired",
          "create_time": "2021-10-20 15:09:38"
        }
    ]
}


{
  "items": [
    {
      "id": "423",
      "company_id": "1000163",
      "inviter_id": "1123163",
      "access": "{\n  \"1010\": \"1107\"\n}",
      "name": "John Doe",
      "invitee": "[email protected]",
      "message": "some message",
      "status": "expired",
      "invite_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Searchable fields are: invitee, name and message.

Sortable fields are: id, inviter_id, invitee, name, status, create_time and update_time.

Create an instance of invite 

                https://api.ocamba.com/v2/ocamba/invites

This service allows inviting Users to Ocamba platform.

Request examples

{
  "invitee": "[email protected]",
  "message": "only for testing"
}

Responses

Response examples

{
  "id": "295",
  "company_id": "6345624",
  "inviter_id": "1000077",
  "access": {
      "1010": "1107"
  },
  "invitee": "[email protected]",
  "name": "john.doe",
  "message": "only for testing",
  "status": "pending"
}

Get an instance of invite 

                https://api.ocamba.com/v2/ocamba/invites/{id}

Returns details of an invite sent by specified ID.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique id of the invite.

Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
      {
        "id": "293",
        "inviter_id": "1000125",
        "invitee": "[email protected]",
        "name": "John Doe",
        "status": "expired",
        "create_time": "2021-10-29T06:59:40Z"
      }
  ]
}


{
  "items": [
    {
      "id": "423",
      "company_id": "1000163",
      "inviter_id": "1123163",
      "access": "{\n  \"1010\": \"1107\"\n}",
      "name": "John Doe",
      "invitee": "[email protected]",
      "message": "some message",
      "status": "expired",
      "invite_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the invite id, list the invites to find it.

Delete an instance of invite 

                https://api.ocamba.com/v2/ocamba/invites/{id}

Allows deletion of an invite with specified ID.

id
string
(required)		Unique id of the invite.
Responses

We recommend you consider other options before deletion.

If you don’t know the invite id, list the invites to find it.

Resend an invite 

                https://api.ocamba.com/v2/ocamba/invites/{id}/resend

Allows resending an invite with specified ID.

id
string
(required)		Unique id of the invite.
Responses

Only expired invites can be resend.

If you don’t know the invite id, list the invites to find it.

Invoices

Get a collection of invoices 

                https://api.ocamba.com/v2/ocamba/invoices
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
company_id
integer
A unique company identifier generated by the Ocamba platform.
status
string
Describe status of the object.
update_time
string
Timezone: GMT.
create_time
string
Timezone: GMT.
id
string (uuid)
A unique identifier generated by the Ocamba platform.
invoice_number
string
The invoice number, generated by Ocamba api. Unique.
app_id
string
A unique app identifier generated by the Ocamba platform.
amount
float
Total amount.
price
float
Sum of prices applied on the invoice line items.
discount
float
Total of discounts applied on the invoice line items.
tax
number (integer)
Total tax on invoice.
currency_code
string
Three-letter, uppercase currency code.
sent
number (integer)
Indicates if invoice is sent to company billing address or not.
start_time
string
When billing period starts.
end_time
string
When billing period ends.
payment_time
string
When invoice was paid. Only for ‘paid’ invoices.
due_date
string
Due date.
Responses

total
integer
items
Response examples

{
    "total": 209,
    "items": [
        {
            "id": "2c9ab0a8-d0d2-49aa-b790-9697cc3aed14",
            "company_id": "6197120",
            "app_id": "1003",
            "invoice_number": "OCM-213376",
            "status": "paid",
            "price": 9.99,
            "tax": 2,
            "amount": 11.99,
            "currency_code": "USD",
            "pdf": "https://dev-storage.ocamba.com/6197120/ocamba/invoices/OCM-213376.pdf",
            "sent": 1,
            "items": [
                {
                    "name": "Ocamba Push Startup Plan (Monthly)",
                    "quantity": 1,
                    "unit_price": 9.99,
                    "price": 9.99,
                    "discount_rate": 0,
                    "discount": 0,
                    "tax_rate": 20,
                    "tax": 2,
                    "amount": 11.99
                }
            ],
            "due_date": "2021-11-24",
            "payment_time": "2021-11-24 10:23:55",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:24:04"
        },
        {
            "id": "6c5206d1-e4d7-4331-8db6-0fa7b4905592",
            "company_id": "6197120",
            "app_id": "1003",
            "invoice_number": "OCM-213375",
            "status": "paid",
            "price": 99.99,
            "tax": 20,
            "amount": 119.99,
            "currency_code": "USD",
            "pdf": "https://dev-storage.ocamba.com/6197120/ocamba/invoices/OCM-213375.pdf",
            "sent": 1,
            "items": [
                {
                    "name": "Ocamba Push Business Plan (Monthly)",
                    "quantity": 1,
                    "unit_price": 99.99,
                    "price": 99.99,
                    "discount_rate": 0,
                    "discount": 0,
                    "tax_rate": 20,
                    "tax": 20,
                    "amount": 119.99
                }
            ],
            "due_date": "2021-11-24",
            "payment_time": "2021-11-24 08:30:18",
            "create_time": "2021-11-24 08:30:18",
            "update_time": "2021-11-24 08:31:04"
        },
        {
            "id": "c8a1ccbf-7b59-4d8a-aa3d-a246f31432e5",
            "company_id": "6197120",
            "app_id": "1001",
            "invoice_number": "OCM-213372",
            "status": "paid",
            "price": 249.99,
            "tax": 50,
            "amount": 299.99,
            "currency_code": "USD",
            "pdf": "https://dev-storage.ocamba.com/6254628/ocamba/invoices/OCM-213372.pdf",
            "sent": 1,
            "items": [
                {
                    "name": "Ocamba Adex Network Plan (Monthly)",
                    "quantity": 1,
                    "unit_price": 249.99,
                    "price": 249.99,
                    "discount_rate": 0,
                    "discount": 0,
                    "tax_rate": 20,
                    "tax": 50,
                    "amount": 299.99
                }
            ],
            "start_date": "2021-11-23",
            "end_date": "2021-11-23",
            "due_date": "2021-11-23",
            "payment_time": "2021-11-23 11:59:28",
            "create_time": "2021-11-23 11:59:28",
            "update_time": "2021-11-23 13:05:13"
        }
    ]
}


{
  "items": [
    {
      "id": "2c9ab0a8-d0d2-49aa-b790-9697cc3aed14",
      "app_id": "1000",
      "invoice_number": "OCM-210001",
      "status": "paid",
      "price": 99.99,
      "tax": 2.2,
      "amount": 102.19,
      "currency_code": "USD",
      "pdf": "https://storage.ocamba.com/9999999/ocamba/invoices/OCM-210001.pdf",
      "sent": 1,
      "items": [
        {
          "name": "Ocamba Push Startup Plan (Monthly)"
        }
      ],
      "due_date": "2021-11-24",
      "start_date": "2021-11-01",
      "end_date": "2021-11-30",
      "payment_time": "2021-11-24 10:23:55",
      "create_time": "2021-11-10 10:23:55",
      "update_time": "2021-11-10 10:23:55"
    }
  ]
}

Searchable field is invoice_number.

Sortable fields are: invoice_number, status, price, discount, amount, tax, currency_code, xero_status, start_date, end_date, payment_time, due_date, create_time and update_time.

Languages

Get a collection of languages 

                https://api.ocamba.com/v2/ocamba/languages

The read-only languages Service returns the list of languages specified in Ocamba.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
name
string
The name of the language. Example - Arabic.
id
string
Unique id of the language. Example - ar.
code
string
Two-letter, lowercase language code.
code3
string
Three-letter, lowercase language code.
Responses

total
integer
items
Response examples

{
    "total": 40,
    "items": [
        {
            "id": "ar",
            "code": "ar",
            "code3": "ara",
            "name": "Arabic"
        },
        {
            "id": "bg",
            "code": "bg",
            "code3": "bul",
            "name": "Bulgarian"
        },
        {
            "id": "ca",
            "code": "ca",
            "code3": "cat",
            "name": "Catalan"
        }
    ]
}           


{
  "items": [
    {
      "id": "ar",
      "code": "ar",
      "code3": "ara",
      "name": "Arabic"
    }
  ]
}

Searchable field is name.

Sortable fields are: name, code, code3 and id.

Get a language 

                https://api.ocamba.com/v2/ocamba/languages/{id}

The read-only language service returns name of the language with specified id.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string
(required)		Unique id of the language. Example - ar.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
            "id": "ar",
            "code": "ar",
            "code3": "ara",
            "name": "Arabic"
        }
    ]
}   


{
  "items": [
    {
      "id": "ar",
      "code": "ar",
      "code3": "ara",
      "name": "Arabic"
    }
  ]
}

If you don’t know the language id, list the languages to find it.

Media-library

Get a collection of media libraries 

                https://api.ocamba.com/v2/ocamba/media-library

Returns the list of company related media existing in Ocamba

view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
Responses

total
integer
items
Response examples

{
  "total": 30,
  "items": [
    {
        "id": "124",
        "company_id": "6123120",
        "app_id": "1001",
        "user_id": "1001277",
        "location": "https://sm.ocmcore.com/share/6123120/adex/media/16919029-joda.jpeg",
        "name": "joda.jpeg",
        "size": 193302,
        "mime_type": "image/jpeg",
        "width": 1200,
        "height": 900,
        "create_time": "2022-03-28 08:36:19",
        "update_time": "2022-03-28 08:36:19"
    },
    {
        "id": "123",
        "company_id": "6123120",
        "app_id": "1001",
        "user_id": "1001277",
        "location": "https://sm.ocmcore.com/share/6123120/adex/media/1255776809-rick.jpeg",
        "name": "rick.jpeg",
        "size": 5020,
        "mime_type": "image/jpeg",
        "width": 200,
        "height": 200,
        "create_time": "2022-03-28 08:35:59",
        "update_time": "2022-03-28 08:35:59"
    },
    {
        "id": "122",
        "company_id": "6123120",
        "app_id": "1001",
        "user_id": "1001277",
        "location": "https://sm.ocmcore.com/share/6123120/adex/media/3846873605-test1234.png",
        "name": "test1234.png",
        "size": 41236,
        "mime_type": "image/png",
        "width": 400,
        "height": 479,
        "create_time": "2022-03-28 08:35:32",
        "update_time": "2022-03-28 08:35:32"
    }
  ]
}


{
  "items": [
    {
      "id": "12",
      "company_id": "1000123",
      "app_id": "1000123",
      "user_id": "1123143",
      "location": "https://sm.ocmcore.com/share/6191234/adex/media/3945083025-example.png",
      "name": "example",
      "mime_type": "image/jpeg",
      "size": 4356,
      "width": 300,
      "height": 300,
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Create an instance of media library 

                https://api.ocamba.com/v2/ocamba/media-library

Uploads the media to the system.

Request examples

--form 'app="adex"' \
--form 'file=@"path/example.jpeg"'
Responses

Response examples

{
  "id": "12",
  "company_id": "1000123",
  "app_id": "1000123",
  "user_id": "1123143",
  "location": "https://sm.ocmcore.com/share/6191234/adex/media/3945083025-example.png",
  "name": "example",
  "mime_type": "image/jpeg",
  "size": 4356,
  "width": 300,
  "height": 300,
  "create_time": "2021-07-30 12:50:13",
  "update_time": "2021-07-30 12:50:13"
}

Image upload can only be accomplished using the multipart/form-data, as shown in the example.

Get an instance of media library 

                https://api.ocamba.com/v2/ocamba/media-library/{id}

Show details of media library with specified id.

id
string
(required)		Unique identifier for media library.
Responses

total
integer
items
Response examples

{
  "total": 1,
  "items": [
    {
      "id": "12",
      "company_id": "1000123",
      "app_id": "1000123",
      "user_id": "1123143",
      "location": "https://sm.ocmcore.com/share/6191234/adex/media/3945083025-example.png",
      "name": "example",
      "mime_type": "image/jpeg",
      "size": 4356,
      "width": 300,
      "height": 300,
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the media library id, list the media libraries to find it.

Delete an instance of media library 

                https://api.ocamba.com/v2/ocamba/media-library/{id}

Deletes media library with the specified id.

id
string
(required)		Unique identifier for media library.
Responses

This change will be automatically synchronized to an ad server.

We recommend you consider other options before deletion.

If you don’t know the media library id, list the media libraries to find it.

Members

Get a collection of members 

                https://api.ocamba.com/v2/ocamba/members

Members function returns details of the selected members.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
status
string
Represents member’s current status. May be Active, Pending, Expired.
email
string
Member’s email address.
id
integer
Unique member’s id.
Responses

total
integer
items
Response examples

{
  "total": 29,
  "items": [
    {
      "id": "1000163",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2021-07-30T12:50:13Z",
      "update_time": "2021-07-30T12:50:13Z"
    },
    {
      "id": "1000006",
      "name": "Jane Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2020-08-28T11:29:48Z",
      "update_time": "2021-04-15T17:13:59Z"
    },
    {
      "id": "1000005",
      "name": "Johnny Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://storage.ocamba.com/6197120/members/1000005/image/jonny.png"
    }
  ]
}


{
  "items": [
    {
      "id": "1000163",
      "company_id": "1000000",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://image-uri-example.com",
      "preferences": {},
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Get an instance of member 

                https://api.ocamba.com/v2/ocamba/members/{id}

Show details for a member, by provided ID.

id
string
(required)		Unique member id.
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.

Responses

total
integer
items
Response examples

{
  "total": 29,
  "items": [
    {
      "id": "1000163",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2021-07-30T12:50:13Z",
      "update_time": "2021-07-30T12:50:13Z"
    }
  ]
}


{
  "items": [
    {
      "id": "1000163",
      "company_id": "1000000",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://image-uri-example.com",
      "preferences": {},
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the member id, list the members to find it.

Delete an instance of member 

                https://api.ocamba.com/v2/ocamba/members/{id}

Delete a member, by provided ID.

id
string
(required)		Unique member id.
Responses

We recommend you consider other options before deletion.

If you don’t know the member id, list the members to find it.

Update an instance of member 

                https://api.ocamba.com/v2/ocamba/members/{id}

Update a member, by provided ID.

id
string
(required)		Unique member id.

Request examples

{ 
  "name": "Doe Jonesd"
}

Responses

At least one of the updatable fields should be sent via HTTP body in order to change the current state of the member.

If you don’t know the member id, list the members to find it.

Update an image of member 

                https://api.ocamba.com/v2/ocamba/members/{id}/image

Update image of a member with the specified id.

id
string
(required)		Unique member id.
Request examples

--form 'file=@"path/logo.jpeg"'
Responses

If you don’t know the member id, list the members to find it.

Delete member image 

                https://api.ocamba.com/v2/ocamba/members/{id}/image

Delete image of a member with the specified id.

id
string
(required)		Unique member id.
Responses

We recommend you consider other options before deletion.

If you don’t know the member id, list the members to find it.

Orders

Get a collection of orders 

                https://api.ocamba.com/v2/ocamba/orders

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
update_time
string
Timezone: GMT.
create_time
string
Timezone: GMT.
id
string (uuid)
A unique identifier generated by the Ocamba platform.
details
string
Additional information about an order.
amount
number
Order price.
currency_code
string
Three-letter, uppercase currency code.
start_time
string
Timezone: GMT.
app_id
string
(required)		A unique company identifier generated by the Ocamba platform.

Responses

total
integer
items
Response examples

{
    "total": 209,
    "items": [
        {
            "id": "c7db9321-dc48-43f1-b32d-a45a4991879a",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Startup Plan (Monthly)",
            "amount": 11.99,
            "currency_code": "USD",
            "start_time": "2021-11-24 10:23:55",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:23:55"
        },
        {
            "id": "f6082c6e-a535-4591-831a-0ac23d08d7f3",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Business Plan (Monthly)",
            "amount": 119.99,
            "currency_code": "USD",
            "start_time": "2021-11-24 08:30:18",
            "create_time": "2021-11-24 08:30:18",
            "update_time": "2021-11-24 08:30:18"
        },
        {
            "id": "6363e70f-baca-4a1f-b0d3-82b5628048ed",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Startup Plan (Monthly)",
            "amount": 11.99,
            "currency_code": "USD",
            "start_time": "2021-11-22 12:13:32",
            "create_time": "2021-11-22 12:13:32",
            "update_time": "2021-11-22 12:13:32"
        }
    ]
}  


{
  "items": [
    {
      "id": "1000163",
      "company_id": "1000000",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://image-uri-example.com",
      "preferences": {},
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Searchable field is details.

Sortable fields are: amount, currency_code, start_date, create_time and update_time.

Get an instance of order 

                https://api.ocamba.com/v2/ocamba/orders/{id}

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string (uuid)
(required)		A unique identifier generated by the Ocamba platform.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
            "id": "c7db9321-dc48-43f1-b32d-a45a4991879a",
            "company_id": "6197120",
            "app_id": "1003",
            "details": "Ocamba Push Startup Plan (Monthly)",
            "amount": 11.99,
            "currency_code": "USD",
            "start_time": "2021-11-24 10:23:55",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:23:55"
        }
    ]
} 


{
  "items": [
    {
      "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
      "company_id": "1234567",
      "app_id": "1003",
      "details": "Ocamba Push Startup Plan (Monthly)",
      "amount": 10.99,
      "currency_code": "USD",
      "start_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the order id, list the orders to find it.

Os

Get a collection of oss 

                https://api.ocamba.com/v2/ocamba/os

The read-only oss service returns the list of operating systems registered in Ocamba.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
string
Unique id of the operating system. Example - 12
name
string
The name of the operating system. Example - Android
Responses

total
integer
items
Response examples

{
    "total": 12,
    "items": [
        {
          "id": "12",
          "name": "Android"
        },
        {
          "id": "11",
          "name": "BlackBerry"
        },
        {
          "id": "18",
          "name": "Chrome"
        }
    ]
}          


{
  "items": [
    {
      "id": "12",
      "name": "Android",
      "versions": {
        "id": "12",
        "name": "Android",
        "versions": "11.0"
      }
    }
  ]
}

Searchable field is name.

Sortable fields are name and id.

Get a os 

                https://api.ocamba.com/v2/ocamba/os/{id}

The read-only os Service displays information about the operating system with the specified id

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique id of the operating system. Example - 12

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "12",
          "name": "Android"
        }
    ]
} 


{
  "items": [
    {
      "id": "12",
      "name": "Android",
      "versions": {
        "id": "12",
        "name": "Android",
        "versions": "11.0"
      }
    }
  ]
}

If you don’t know the os id, list the oss to find it.

Regions

Get a collection of regions 

                https://api.ocamba.com/v2/ocamba/regions

The read-only regions service displays the information about the regions and the 2-letter country codes of the countries they belong.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
string
Unique id of the region. Example id=“2661876”.
name
string
The name of the region. Example name=“Aargau”.
Responses

total
integer
items
Response examples

{
    "total": 3150,
    "items": [
        {
            "id": "831053",
            "name": "Kosovo",
            "country_code": "RS",
            "full_name": "Kosovo, RS"
        },
        {
            "id": "2661876",
            "name": "Aargau",
            "country_code": "CH",
            "full_name": "Aargau, CH"
        },
        {
            "id": "2565340",
            "name": "Abia State",
            "country_code": "NG",
            "full_name": "Abia State, NG"
        },
        {
            "id": "11153151",
            "name": "Abidjan",
            "country_code": "CI",
            "full_name": "Abidjan, CI"
        }
    ]
}


{
  "items": [
    {
      "id": "2661876",
      "name": "Aargau",
      "country_code": "CH",
      "full_name": "Aargau, CH"
    }
  ]
}

Searchable field is name, id and full_name.

Sortable fields are name, id, country_code and full_name.

Get a region 

                https://api.ocamba.com/v2/ocamba/regions/{id}

The read-only region Service displays information about the region with the specified id

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string
(required)		Unique id of the region. Example id=“2661876”.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "2661876",
          "name": "Aargau",
          "country_code": "CH",
          "full_name": "Aargau, CH"
        }
    ]
} 


{
  "items": [
    {
      "id": "2661876",
      "name": "Aargau",
      "country_code": "CH",
      "full_name": "Aargau, CH"
    }
  ]
}

If you don’t know the region id, list the regions to find it.

Reports

Get a collection of reports 

                https://api.ocamba.com/v2/ocamba/reports
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
Responses

Create an instance of report 

                https://api.ocamba.com/v2/ocamba/reports

Request examples

{
  "name": "Top 10",
  "description": "Displays top 10 exchanges with highest income",
  "ds": "{ \"fields\": \"exchange_name,income\", \"source\": \"adex.exchange\", \"limit\": \"10\", \"order\": { \"field\" : \"income\", \"op\" : \"-\" } }"
}

Responses

Get an instance of report 

                https://api.ocamba.com/v2/ocamba/reports/{id}
Responses

Update an instance of report 

                https://api.ocamba.com/v2/ocamba/reports/{id}

Request examples

{
  "name": "Top 10",
  "description": "Displays top 10 exchanges with highest income",
  "ds": "{ \"fields\": \"exchange_name,income\", \"source\": \"adex.exchange\", \"limit\": \"10\", \"order\": { \"field\" : \"income\", \"op\" : \"-\" } }"
}

Responses

System report can’t be modified.

If you don’t know the report id, list the reports to find it.

Delete a single instance of report 

                https://api.ocamba.com/v2/ocamba/reports/{id}
Responses

System report can’t be deleted.

If you don’t know the report id, list the reports to find it.

Timezones

Get a collection of timezones 

                https://api.ocamba.com/v2/ocamba/timezones

The read-only timezones service displays the information about the timezones.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
id
string
Unique id of the timezone. Example NST.
name
string
The name of the timezone. Example “New Zealand Standard Time”.
code
string
Three-letter, uppercase timezone code.
Responses

total
integer
items
Response examples

{
    "total": 28,
    "items": [
        {
            "id": "NST",
            "code": "NST",
            "name": "New Zealand Standard Time",
            "short_offset": 12,
            "offset": "GMT+12:00",
            "create_time": "2021-01-22 10:00:28",
            "update_time": "2021-01-22 12:45:02"
        },
        {
            "id": "SST",
            "code": "SST",
            "name": "Solomon Standard Time",
            "short_offset": 11,
            "offset": "GMT+11:00",
            "create_time": "2021-01-22 10:00:28",
            "update_time": "2021-01-22 10:00:28"
        },
        {
            "id": "AET",
            "code": "AET",
            "name": "Australia Eastern Time",
            "short_offset": 10,
            "offset": "GMT+10:00",
            "create_time": "2021-01-22 10:00:28",
            "update_time": "2021-01-22 12:45:02"
        }
    ]
}       


{
  "items": [
    {
      "id": "NST",
      "code": "NST",
      "name": "New Zealand Standard Time",
      "short_offset": 12,
      "offset": "GMT+12:00",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Searchable field is name.

Sortable fields are: id, code, name, short_offset, offset, create_time and update_time.

Get a timezone 

                https://api.ocamba.com/v2/ocamba/timezones/{id}

The read-only timezone service displays information about the timezone with the specified id

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
id
string
(required)		Unique id of the timezone. Example NST.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
          "id": "NST",
          "code": "NST",
          "name": "New Zealand Standard Time",
          "short_offset": 12,
          "offset": "GMT+12:00",
          "create_time": "2021-01-22 10:00:28",
          "update_time": "2021-01-22 12:45:02"
        }
    ]
} 


{
  "items": [
    {
      "id": "NST",
      "code": "NST",
      "name": "New Zealand Standard Time",
      "short_offset": 12,
      "offset": "GMT+12:00",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the timezone id, list the timezones to find it.

Traffic-sources

Get a collection of traffic-sources 

                https://api.ocamba.com/v2/ocamba/traffic-sources

The read-only traffic-sources service displays the information about the sources of the incoming traffic to the site.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
string
Unique id of the traffic source. Example id=2.
name
string
The name of the traffic source. Example - Direct, Internal, Link, Search Engine, Social Network, Paid, Other, Undefined, Unknown.
Responses

total
integer
items
Response examples

{
  "items": [
    {
      "id": "2",
      "name": "Paid"
    }
  ]
}

Searchable field is name.

Sortable fields are name and id.

Get a traffic-source 

                https://api.ocamba.com/v2/ocamba/traffic-sources/{id}

The read-only traffic-source service displays information about the source of the traffic to the site with the specified id.

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
name
string
Name of the object.
id
string
(required)		Unique id of the traffic source. Example id=2.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
      {
          "id": "1",
          "name": "Direct"
      }        
    ]
}


{
  "items": [
    {
      "id": "2",
      "name": "Paid"
    }
  ]
}

Searchable field is name.

Sortable fields are name and id.

Transactions

Get a collection of transactions 

                https://api.ocamba.com/v2/ocamba/transactions
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
update_time
string
Timezone: GMT.
create_time
string
Timezone: GMT.
id
string (uuid)
A unique identifier generated by the Ocamba platform.
payment_provider
string
Name of the payment provider.
amount
float
Transaction price.
currency_code
string
Three-letter, uppercase currency code.
Responses

total
integer
items
Response examples

{
    "total": 188,
    "items": [
        {
            "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
            "company_id": "1234567",
            "invoice_numbers": [
                "OCM-213376"
            ],
            "payment_provider": "paypal",
            "amount": 11.99,
            "currency_code": "USD",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:24:02"
        },
        {
            "id": "71dd4289-0f8a-4c3d-b6ef-5658c17a9e20",
            "company_id": "1234567",
            "invoice_numbers": [
                "OCM-213375"
            ],
            "payment_provider": "paypal",
            "amount": 119.99,
            "currency_code": "USD",
            "create_time": "2021-11-24 08:30:18",
            "update_time": "2021-11-24 08:31:02"
        },
        {
            "id": "bae70678-efbb-4448-b83c-5d3c5beb9f96",
            "company_id": "1234567",
            "invoice_numbers": [
                "OCM-213370"
            ],
            "payment_provider": "paypal",
            "amount": 11.99,
            "currency_code": "USD",
            "create_time": "2021-11-22 12:13:32",
            "update_time": "2021-11-22 12:14:01"
        }
    ]
}


{
  "items": [
    {
      "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
      "company_id": "1234567",
      "invoice_numbers": [
        "OCM-213376"
      ],
      "payment_provider": "paypal",
      "amount": 10.99,
      "currency_code": "USD",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Searchable field is payment_provider.

Sortable fields are: amount, currency_code, xero_status, create_time and update_time.

Get a transaction 

                https://api.ocamba.com/v2/ocamba/transactions/{id}

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
id
string (uuid)
(required)		A unique identifier generated by the Ocamba platform.

Responses

total
integer
items
Response examples

{
    "total": 1,
    "items": [
        {
            "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
            "company_id": "1234567",
            "invoice_numbers": [
                "OCM-213376"
            ],
            "payment_provider": "paypal",
            "amount": 11.99,
            "currency_code": "USD",
            "create_time": "2021-11-24 10:23:55",
            "update_time": "2021-11-24 10:24:02"
        }
    ]
} 


{
  "items": [
    {
      "id": "37ca408f-59d8-4910-bcb0-54dad2641c61",
      "company_id": "1234567",
      "invoice_numbers": [
        "OCM-213376"
      ],
      "payment_provider": "paypal",
      "amount": 10.99,
      "currency_code": "USD",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

If you don’t know the transaction id, list the transactions to find it.

Usages

Get a collection of billing 

                https://api.ocamba.com/v2/ocamba/usage

fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
id
integer
Unique identifier for the object defined as a query parameter.
create_time
string
Timezone: GMT.
update_time
string
Timezone: GMT.
price
number
App total price.
discount
number
App total discount.
amount
number
App total amount.
currency_code
string
Three-letter, uppercase currency code.
limit_status
string
Describe a limit status.
usage_percent
integer
App usage percent.
start_time
string
Timezone: GMT.
end_time
string
Timezone: GMT.
app_id
string
(required)		A unique company identifier generated by the Ocamba platform.

Responses

total
integer
items
Response examples

{
    "total": 3,
    "items": [
        {
            "id": "1971",
            "company_id": "6197120",
            "app_id": "1001",
            "items": [
                {
                    "name": "adex requests",
                    "quantity": 5938,
                    "unit_price": 0,
                    "price": 0,
                    "discount_rate": 0,
                    "discount": 0,
                    "tax_rate": 20,
                    "tax": 0,
                    "amount": 0,
                    "description": "Adex Requests",
                    "unit": 1
                }
            ],
            "currency_code": "USD",
            "limit_status": "0",
            "usage_percent": 0.59,
            "start_time": "2021-11-01T00:00:00Z",
            "end_time": "2021-11-30T00:00:00Z"
        },
        {
            "id": "1969",
            "company_id": "6197120",
            "app_id": "1007",
            "items": [
                {
                    "name": "enterprise",
                    "quantity": 1,
                    "unit_price": 1,
                    "price": 1,
                    "discount_rate": 0,
                    "discount": 0,
                    "tax_rate": 20,
                    "tax": 0.2,
                    "amount": 1.2,
                    "description": "Ocamba MST Enterprise Plan (Annually)",
                    "unit": 1
                }
            ],
            "price": 1,
            "amount": 1.2,
            "currency_code": "USD",
            "limit_status": "0",
            "start_time": "2021-10-30T00:00:00Z",
            "end_time": "2021-11-29T00:00:00Z"
        },
        {
            "id": "1982",
            "company_id": "6197120",
            "app_id": "1003",
            "items": [
                {
                    "name": "subscribers",
                    "quantity": 98985,
                    "unit_price": 0,
                    "price": 0,
                    "discount_rate": 0,
                    "discount": 0,
                    "tax_rate": 20,
                    "tax": 0,
                    "amount": 0,
                    "description": "Subscribers included in plan",
                    "unit": 1
                }
            ],
            "currency_code": "USD",
            "limit_status": "0",
            "usage_percent": 100,
            "start_time": "2021-11-10T00:00:00Z",
            "end_time": "2021-12-09T00:00:00Z"
        }
    ]
}    


{
  "items": [
    {
      "id": "1998",
      "company_id": "10013213",
      "app-id": "1000163",
      "app": {
        "id": "123456789",
        "type": "application",
        "title": "AdExchange",
        "name": "adex",
        "description": "here goes description",
        "logo": "https://logo-uri-example.com",
        "plan": "'{ \n   \"features\" : [\"billing\"]\n }'",
        "create_time": "2021-11-25 13:45:03",
        "update_time": "2021-11-26 11:37:25"
      },
      "items": [
        {
          "invoice_item": {
            "name": "Ocamba Push Startup Plan (Monthly)"
          },
          "description": "Subscribers included in plan",
          "unit": 1
        }
      ],
      "amount": 1.2,
      "price": 10.99,
      "currency_code": "USD",
      "limit_status": "0",
      "usage_percent": 100,
      "start_date": "2021-07-20",
      "end_date": "2021-07-30",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}

Searchable field is items.

Sortable fields are: price, discount, amount, currency_code, limit_status, usage_percent, start_date, end_date, create_time and update_time.

Widgets

Get a collection of widgets 

                https://api.ocamba.com/v2/ocamba/widgets
fields
string
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See “Tips” for the list of filterable parameters.
view
string
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.
page
string
The page number indicates which set of items will be returned in the response. The format of request is “page=N,M” where ‘N’ (required) represents page number and ‘M’ (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.
sort
string
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix “-” for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.
q
string
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string ‘sou’

See tips for the list of searchable parameters.
q_fields
string
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string ‘sou’.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string ‘sou’ in any of the specified fields.

See tips for the list of searchable parameters.
dashboard_id
string
List widgets that are assigned to the provided dashboard
Responses

Create an instance of widget 

                https://api.ocamba.com/v2/ocamba/widgets

Request examples

{
  "app_id": "1001",
  "ref": "w1",
  "name": "Top 10",
  "description": "Displays top 10 users with most activities",
  "system": 1,
  "type": "timeline"
}

Responses

Get an instance of widget 

                https://api.ocamba.com/v2/ocamba/widgets/{id}
Responses

Update an instance of widget 

                https://api.ocamba.com/v2/ocamba/widgets/{id}

Request examples

{
  "app_id": "1001",
  "ref": "w1",
  "name": "Top 10",
  "description": "Displays top 10 users with most activities",
  "system": 1,
  "type": "timeline"
}

Responses

Changes will be applied on all dashboards associated with this widget.

System widget can’t be modified.

If you don’t know the widget id, list the widgets to find it.

Deletes an instance of widget 

                https://api.ocamba.com/v2/ocamba/widgets/{id}
Responses

Deleting a widget will remove the widget from all dashboards.

System widget can’t be deleted.

If you don’t know the widget id, list the widgets to find it.

Schema definitions

Account

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 1000000
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 1000001
creator_id
string
(required)		A unique creator identifier generated by the Ocamba platform.
Example: 1000001
status
string
(required)		The status reflects the current status of the account which may be overridden by some background processes.
Example: active
ssp_configuration
Configuration of the SSP.
configured_status
string
(required)		The configured_status reflects the current status of the account configured by the client.
Example: active
name
string
(required)		Name of the account.
Example: Demo account
image
string (uri)		URL to the account image.
Example: https://storage.ocamba.com/1000001/adex/accounts/1000000/account.jpeg
contacts
[ account-contact ]		List of account contacts.
feeds
Values that are pasted to the creative landing URL.
is_default
integer
(required)		For default account is_default is set to 1. Default account can’t be removed.
Example: 1
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-10-29 12:47:00
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-10-30 14:27:26

Account Contact

NameDescription
id
string (uuid)
(required)		A unique identifier generated by the Ocamba platform.
Example: 95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b
type
string
(required)		Describes type of the contact.
Example: email
value
string
(required)		The actual contact, based on contact type. For example, if contact type is email, the value must be a valid email address.
Example: [email protected]

Account Limit

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 1000
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 1000001
account_id
string
(required)		A unique account identifier generated by the Ocamba platform.
Example: 1000000
type
string
(required)		Represent the type of the account limit.
Example: budget
item
string
(required)		Depends on the type. If type is budget allowed values are income and expense. If type is frequency allowed values are: impressions, clicks and conversions.
Example: income
period
string
(required)		Describe the period of the limit.
Example: day
value
integer
(required)		Value of the upper limit.
Example: 1
create_time
string
(required)		Timezone: GMT.
Example: 2021-10-29 12:47:00
update_time
string
(required)		Timezone: GMT.
Example: 2021-10-30 14:27:26

Action

NameDescription
id
string		The ID of the action, generated by Ocamba API.
Example: 1014
integration_id
string		The ID of the integration.
Example: 10014
name
string		The Action name.
Example: Create Ticket
item
string
(required)		The Action item.
Example: Ticket
engine
string
(required)		Action engine.
Example: email
properties
properties		The Action properties map.
description
string
(required)		The detailed Action description.
Example: Creates a Ticket
create_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13

Address

NameDescription
street
string
(required)		Street location.
Example: Dragise Misovica 163b
city
string
(required)		City location.
Example: Cacak
country
string
(required)		Country location.
Example: RS
postal_code
string
(required)		Postal code.
Example: 32000

App

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 123456789
type
string
(required)		Describe app type.
Example: application
title
string
(required)		Represent the title of the app.
Example: AdExchange
name
string
(required)		Represent name of the app.
Example: adex
description
string		Additional information about an app.
Example: here goes description
logo
string (uri)		Represent the logo of app.
Example: https://logo-uri-example.com
plan
string
(required)		Represent the pricing plan.
Example: ‘{ “features” : [“billing”] }’
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-25 13:45:03
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-26 11:37:25

App Store

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 123456789
type
string
(required)		Describe app type.
Example: application
title
string
(required)		Represent the title of the app.
Example: AdExchange
name
string
(required)		Represent name of the app.
Example: adex
description
string
(required)		Additional information about an app.
Example: here goes description
logo
string (uri)		Represent the logo of app.
Example: https://logo-uri-example.com
is_published
number (integer)
(required)		Describes application publish status.
Example: 0
published_version
string		Latest published version.
Example: 1.0.10
rc_version
string		Release candidate.
Example: 2.0.1
status
string
(required)		Describes status of the app.
Example: trial
installed_version
string		Installed version.
Example: 2.0.28
plan
object		Plan object.
trial
object		Trial object.
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-25 13:45:03
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-26 11:37:25

Auth

NameDescription
Username
string
(required)		Unique user identification.
Example: [email protected]
Password
string
(required)		Unique string used to verify the identity of a user.
Example: Test1234
Domain
string
(required)		Access domain of the company.
Example: demo.app

Automation

NameDescription
id
string		The ID of the event, generated by Ocamba API.
Example: 10001
company_id
string		The ID of the integration.
Example: 6197120
status
string
(required)		The Status of Automation.
Example: active
name
string		The Automation name.
Example: First automation
description
string		The detailed Automation description.
Example: Push welcome
event
[ ebs-event ]		Events objects.
actions
[ ebs-action ]		Actions objects.
create_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13

Autonomous System

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 55734
asn
number (integer)
(required)		Name of the Autonomous System Numbers.
Example: 55734
aso
string
(required)		Name of the App Store Optimization.
Example: 001 IT Complex
isp
string
(required)		Name of the Internet service provider.
Example: 001 IT Complex
organization
string
(required)		Name of the organization.
Example: 001 IT Complex

Billing

NameDescription
email
string
(required)		Billing emial address.
Example: [email protected]
address

(required)		Billing address.

Browser

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 12
name
string
(required)		Browser name.
Example: Chrome
versions
[ browser-version ]
(required)		Array of browser versions objects.

Browser Version

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 174
name
string
(required)		Full name of the browser version.
Example: Chrome 10
versions
string
(required)		Versions number.
Example: 10.0

City

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 5881639
country_code
string		Two-letter, uppercase country code which is city located.
Example: CA
region
string		The region name which is city located.
Example: British Columbia
name
string
(required)		City name.
Example: 100 Mile House
full_name
string
(required)		Full name.
Example: 100 Mile House, British Columbia, CA

Company

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 1000163
ownver_id
string
(required)		A unique owner identifier generated by the Ocamba platform.
Example: 10132163
xero_id
string		A unique identifier from an external source.
Example: c13a387e-af72-475d-98ef-b03dfae8d750
name
string
(required)		Full name of a company.
Example: Ocamba App
short_name
string		Short name of a company.
Example: OAPP
status
string
(required)		Describe an account status.
Example: active
domain
string
(required)		Company domain name.
Example: demo.app
registration_number
string		A unique registration number generated by the Ocamba platform.
Example: 12345
vat_id
string		Company VAT ID.
Example: 45
logo
string (uri)		Defines the logo of company.
Example: https://path/logo.jpeg
address
string		Company address.
Example: Dragise Misovic 163b, Cacak, Serbia
email
string		Company email address.
Example: [email protected]
website
string (uri)
(required)		Company website url.
Example: https://www.google.com
preferences
member-settings		Member settings object.
billing
billing		Billing object.
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Connection Type

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 2
name
string
(required)		Connection type name.
Example: cable/dsl

Country

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: AF
code
string
(required)		Two-letter, uppercase country code.
Example: AF
code3
string
(required)		Three-letter, uppercase country code.
Example: AFG
name
string
(required)		Country name.
Example: Afghanistan

Currency

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: CNY
code
string
(required)		Three-letter, uppercase currency code.
Example: CNY
name
string
(required)		Currency name.
Example: Chinese Yuan Renminbi
rate
float
(required)		An exchange rate.
Example: 6.3848

Dashboard

NameDescription
id
string (uuid)
(required)		The ID of the dashboard, generated by Ocamba API.
Example: 2c9ab0a8-d0d2-49aa-b790-9697cc3aed14
company_id
string
(required)		The ID of the company, assigned by Ocamba API.
app_id
string
(required)		The ID of the application, assigned by Ocamba API.
Example: 1001
creator_id
string
(required)		The ID of the member who creates a dashboard, assigned by Ocamba API.
name
string
(required)		The dashboard name. Minimum length 1. Maximum length 100.
Example: Activity dashboard
description
string		The detailed dashboard description. Minimum length 5. Maximum length 1000.
Example: Displays user activity
icon
string
(required)		The dashboard icon.
system
integer
(required)		Describe dashboard system status.
Example: 1
is_default
integer
(required)		Describe dashboard default status.
Example: 1
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Device

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 14
name
string
(required)		Device name.
Example: APPLE

Event system - Action

NameDescription
id
string		The ID of the event, generated by Ocamba API.
Example: 1002
integration_id
string		The ID of the integration.
Example: 10000
data
object		Action data.
Example: { “body”: { “user_id”: “{{event.user_id}}”, “zone_id”: “123345678” } }
filters
[ ebs-filter ]		A tool for finding and executing only the event that is matched with filter.
Example: [ {“key”:"{{event.tag_id}}",“match”:“in:120,960”} ]
actions
[ ebs-action ]		New actions to execute.
Example: [ { “id”:“1010”, “integration_id”:“10000”, “data”:{ “body”:{ “user_id”:"{{event.user_id}}", “zone_id”:“123456” } } } ]

Event system - Event

NameDescription
id
string		The ID of the event, generated by Ocamba API.
Example: 1000
integration_id
string		The ID of the integration.
Example: 10000

Event system - Filter

NameDescription
key
string
(required)		The tag id that filters events.
Example: {{event.tag_id}}
match
string
(required)		Input that will match event key.
Example: 120
filters
[ ebs-filter ]		A tool for finding and executing only the event that is matched with filter.
Example: [ {“key”:"{{event.tag_id}}",“match”:“in:120,960”} ]

Error

NameDescription
code
integer
(required)		Equal to HTTP response status code.
Example: 400
title
string
(required)		A general error message, available for both ‘client-side’ and ‘server-side’ responses.
Example: Bad Request.
message
string		A more detailed human-readable error message, indicating why the request cannot be fulfilled. Not available for the ‘server-side’ errors.
Example: The name may not be greater than 100 characters.
trace_id
string
(required)		A unique identifier for the provided error, generated on the server-side for correlation purposes.
Example: 2431b61e-8a07-433f-8051-2b204e59e52d
details
An object that contains individual instance of the error. This field SHOULD be required for ‘client-side’ errors, but there is no guarantee that details can be extracted for all ‘client-side’ errors.

Event

NameDescription
id
string		The ID of the event, generated by Ocamba API.
Example: 1026
integration_id
string		The ID of the integration.
Example: 10002
name
string
(required)		The Event name.
Example: Create Event
item
string
(required)		The Event item.
Example: item
description
string
(required)		The detailed Event description.
Example: Creates a Event
create_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13

General Settings

NameDescription
theme
string
(required)		Theme which will be applied to the overall Ocamba UI.
Example: light
timezone
integer
(required)		Time zone which will be applied to the overall Ocamba UI.
Example: 1
number_format

(required)		Number format which will be applied to the overall Ocamba UI.
date_format
string
(required)		Date format which will be applied to the overall Ocamba UI.
Example: DD-MM-YYYY
time_format
string
(required)		Time format which will be applied to the overall Ocamba UI.
Example: 24
first_week_day
string
(required)		First day of week which will be applied to the overall Ocamba UI.
Example: mon
currency
string
(required)		Currency which will be applied to all Ocamba platform transactions.
Example: EUR

Integration

NameDescription
id
string		The ID of the dashboard, generated by Ocamba API.
Example: 10014
name
string
(required)		The integration name.
Example: Integration
description
string
(required)		The detailed integration description.
Example: Description of integration
logo
string (url)		The integration icon.
Example: https://www.google.com/search?q=logo&rlz=1C5CHFA_enRS985RS988
homepage
string (url)		The integration homepage.
Example: https://delsystems.net/index.htm
version
string		The integration version.
Example: 1.1.10
audience
string
(required)		Integration audiece.
Example: public
events
[ event ]		Array of integration events objects.
actions
[ action ]		Array of integration actions objects.
create_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime		Timezone: GMT.
Example: 2021-07-30 12:50:13

Invite

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 423
company_id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 1000163
inviter_id
string
(required)		A unique inviter identifier generated by the Ocamba platform.
Example: 1123163
access
object		Key value pair of app_id(key) and role_id(value).
Example: { “1010”: “1107” }
name
string		Name of the person invited to Ocamba platform.
Example: John Doe
invitee
string
(required)		Email address of the person invited to Ocamba platform.
Example: [email protected]
message
string		Optional message sent to user invited to Ocamba.
Example: some message
status
string
(required)		Describes invitation status.
Example: expired
invite_time
dateTime
(required)		Inviting time, Timezone: GMT.
Example: 2021-07-30 12:50:13
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Invoice

NameDescription
id
string (uuid)
(required)		The ID of the invoice, generated by the Ocamba API.
Example: 2c9ab0a8-d0d2-49aa-b790-9697cc3aed14
app_id
string
(required)		The ID of the application
Example: 1000
invoice_number
string
(required)		The invoice number, generated by Ocamba api. Unique.
Example: OCM-210001
status
string
(required)		The current status of the invoice.
Example: paid
price
float
(required)		Sum of prices applied on the invoice line items.
Example: 99.99
discount
float
(required)		Total of discounts applied on the invoice line items.
Example: 0
tax
float
(required)		Total tax on invoice.
Example: 2.2
amount
float
(required)		Total amount.
Example: 102.19
currency_code
string
(required)		The three-letter currency code, supported by Ocamba, that indicates the currency.
Example: USD
pdf
string (uri)		Location of the pdf version of the invoice.
Example: https://storage.ocamba.com/9999999/ocamba/invoices/OCM-210001.pdf
sent
integer
(required)		Indicates if invoice is sent to company billing address or not.
Example: 1
items
[ invoice-item ]
(required)		Array of the invoice items. Minimum length 1.
due_date
date
(required)		Due date
Example: 2021-11-24
start_date
date		When billing period starts.
Example: 2021-11-01
end_date
date		When billing period ends.
Example: 2021-11-30
payment_time
dateTime		When invoice was paid. Only for ‘paid’ invoices.
Example: 2021-11-24 10:23:55
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-10 10:23:55
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-10 10:23:55

Invoice Item

NameDescription
name
string		Name of the invoice.
Example: Ocamba Push Startup Plan (Monthly)
quantity
float
(required)		Line item quantity.
unit_price
float
(required)		Price per one unit.
price
float
(required)		Line item price (price = quantity * unit_price).
discount_rate
float
(required)		Represents a discount expressed as a percentage. Used to calculate discount.
discount
float
(required)		Line item discount (discount = price * discount_rate / 100).
tax_rate
float
(required)		Represents a tax expressed as a percentage. Used to calculate tax.
tax
float
(required)		Line item tax (tax = (price - discount) * tax_rate / 100).
amount
float
(required)		Line item amount (amount = price - discount + tax).

Label

NameDescription
key
string
(required)		The Designer key.
Example: url
type
string
(required)		The Designer type.
Example: string
description
string
(required)		The Designer description.
Example: design description
required
boolean		The Designer required.
Example: true

Language

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: ar
code
string
(required)		Two-letter, lowercase language code.
Example: ar
code3
string
(required)		Three-letter, lowercase language code.
Example: ara
name
string
(required)		Language name.
Example: Arabic

Media Library

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 12
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 1000123
app_id
string
(required)		A unique application identifier generated by the Ocamba platform.
Example: 1000123
user_id
string
(required)		A unique user identifier generated by the Ocamba platform.
Example: 1123143
location
string (url)
(required)		Url location where file is stored.
Example: https://sm.ocmcore.com/share/6191234/adex/media/3945083025-example.png
name
string
(required)		Name of the file.
Example: example
mime_type
string
(required)		Mime type of the file.
Example: image/jpeg
size
integer
(required)		Size of file in bytes.
Example: 4356
width
integer
(required)		Available only for image mime types, represent width of image in pixels.
Example: 300
height
integer
(required)		Available only for image mime types, represent height of image in pixels.
Example: 300
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Member

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 1000163
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 1000000
name
string
(required)		Name of the member.
Example: John Doe
status
string
(required)		Describe member status.
Example: active
email
string (email)
(required)		Member email address.
Example: [email protected]
image
string (url)		The image of the member.
Example: https://image-uri-example.com
preferences
Member settings object.
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Member Settings

NameDescription
general
general-settings
(required)		General settings object.
security
security-settings
(required)		Security settings object.

Order

NameDescription
id
string (uuid)
(required)		A unique identifier generated by the Ocamba platform.
Example: 37ca408f-59d8-4910-bcb0-54dad2641c61
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 1234567
app_id
string
(required)		A unique app identifier generated by the Ocamba platform.
Example: 1003
details
string
(required)		Additional information about an order.
Example: Ocamba Push Startup Plan (Monthly)
amount
float
(required)		Order price.
Example: 10.99
currency_code
string
(required)		Three-letter, uppercase currency code.
Example: USD
start_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Os

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 12
name
string
(required)		Operation system name.
Example: Android
versions
os-version
(required)		Array of os versions objects.

Os Version

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 12
name
string
(required)		Full name of operation system version.
Example: Android
versions
string
(required)		Versions number.
Example: 11.0

Properties

NameDescription
label
label		The key of properties maps.
Example: label

Region

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 2661876
name
string
(required)		Region name.
Example: Aargau
country_code
string
(required)		Country code.
Example: CH
full_name
string
(required)		Full name.
Example: Aargau, CH

Report

NameDescription
id
string (uuid)
(required)		The ID of the report, generated by Ocamba API.
Example: 132
company_id
string
(required)		The ID of the company, assigned by Ocamba API.
Example: 12345678
app_id
string		The ID of the application, assigned by Ocamba API.
creator_id
string		The ID of the creator, assigned by Ocamba API.
ref
string		Ref field is related only with system reports.
name
string
(required)		The widget name. Minimum length 1. Maximum length 100.
Example: Top 10
description
string		The detailed report description. Minimum length 5. Maximum length 1000.
Example: Displays top 10 exchanges with highest income
system
integer		Indicates whether the report is system or user defined. Note that system reports can’t be deleted or modified.
ds
object
(required)		Report configuration.
Example: { “fields”: “exchange_name,income”, “source”: “adex.exchange”, “limit”: “10”, “order”: { “field” : “income”, “op” : “-” } }
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Security Settings

NameDescription
ip_restrictions
[ string ]
(required)		Array of unique IP addresses allowed to access to the Ocamba platform. Only IPv4 format is supported.
country_restrictions
[ string ]
(required)		Array of countries allowed to access to the Ocamba platform.

Signup

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 12345
name
string
(required)		Companuy name.
Example: JohnDoe
domain
string
(required)		Companuy domain.
Example: demo.app
email
string
(required)		Main email of the company.
Example: [email protected]
apps
[ string ]		Array of apps to which the company will have access.
is_new_user
integer
(required)		Indicates if user already exists.
Example: 1
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Timezone

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: NST
code
string
(required)		Three-letter, uppercase timezone code.
Example: NST
name
string
(required)		Full name of the timezone.
Example: New Zealand Standard Time
short_offset
number (integer)
(required)		Short representation of hours a certain time zone is ahead of or behind GMT.
Example: 12
offset
string
(required)		Full representation of hours a certain time zone is ahead of or behind GMT.
Example: GMT+12:00
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Traffic Source

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 2
name
string
(required)		Traffic source type.
Example: Paid

Transaction

NameDescription
id
string (uuid)
(required)		A unique identifier generated by the Ocamba platform.
Example: 37ca408f-59d8-4910-bcb0-54dad2641c61
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 1234567
invoice_numbers
[ string ]		Array of the invoice numbers.
payment_provider
string
(required)		Name of the payment provider.
Example: paypal
amount
number
(required)		Transaction price.
Example: 10.99
currency_code
string
(required)		Three-letter, uppercase currency code.
Example: USD
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Usage

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 1998
company_id
string
(required)		A unique company identifier generated by the Ocamba platform.
Example: 10013213
app-id
string
(required)		A unique app identifier generated by the Ocamba platform.
Example: 1000163
app

(required)		App object.
items
[ object ]
(required)		Array of usage items objects.
amount
float
(required)		App total amount.
Example: 1.2
price
float
(required)		App total price.
Example: 10.99
discount
float
(required)		App total discount.
Example: 0
currency_code
string
(required)		Three-letter, uppercase currency code.
Example: USD
limit_status
string
(required)		Describe a limit status.
Example: 0
usage_percent
integer
(required)		App usage percent.
Example: 100
start_date
dateTime
(required)		Timezone: GMT.
Example: 2021-07-20
end_date
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13

Usage Item

NameDescription
invoice_item

(required)		Invoice item object.
description
string
(required)		The detailed usage item description.
Example: Subscribers included in plan
unit
number
(required)		Usage item unit.
Example: 1

Widget

NameDescription
id
string (uuid)
(required)		The ID of the widget, generated by Ocamba API.
Example: 2c9ab0a8-d0d2-49aa-b790-9697cc3aed14
company_id
string
(required)		The ID of the company, assigned by Ocamba API.
Example: 12345678
app_id
string
(required)		The ID of the application, assigned by Ocamba API.
Example: 1001
ref
string		Ref field is related only with system widgets.
Example: w1
name
string
(required)		The widget name. Minimum length 1. Maximum length 100.
Example: Top 10
description
string		The detailed dashboard description. Minimum length 5. Maximum length 1000.
Example: Displays top 10 users with most activities
system
integer
(required)		Indicates whether the widget is system or user defined. Note that system widgets can’t be deleted or modified.
Example: 1
type
string
(required)		The type of the widget.
Example: timeline
conf
object		The configuration of the widget. It is an arbitrary key-value pair object, where key must be a string, and value can be of any type.
ds
object		widget configuration.
grid
object		widget cordinates.
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-07-30 12:50:13
NameDescription
advertiser
string		Status of the Advertiser. It can contain one of the following values: enabled, disabled or null.
Example: enabled
publisher
string		Status of the Publisher. It can contain one of the following values: enabled, disabled or null.
Example: disabled
NameDescription
postbacks
string
(required)
Example: https://google.com

Address

NameDescription
street
string
(required)		Street location.
Example: Dragise Misovica 163b
city
string
(required)		City location.
Example: Cacak
country
string
(required)		Country location.
Example: RS
postal_code
string
(required)		Postal code.
Example: 32000
NameDescription
field
string
(required)		Pointer to the field in the request body, which triggered the error.
value
string
(required)		Value of the field in error.
rule
string
(required)		Validation rule which indicates what goes wrong.
issue
string
(required)		A human-readable error message.
NameDescription
thousand_separator
string
(required)		Separator represented as dot.
Example: .
decimal_separator
string
(required)		Separator represented as comma.
Example: ,

Member Settings

NameDescription
general
general-settings
(required)		General settings object.
security
security-settings
(required)		Security settings object.

App

NameDescription
id
string
(required)		A unique identifier generated by the Ocamba platform.
Example: 123456789
type
string
(required)		Describe app type.
Example: application
title
string
(required)		Represent the title of the app.
Example: AdExchange
name
string
(required)		Represent name of the app.
Example: adex
description
string		Additional information about an app.
Example: here goes description
logo
string (uri)		Represent the logo of app.
Example: https://logo-uri-example.com
plan
string
(required)		Represent the pricing plan.
Example: ‘{ “features” : [“billing”] }’
create_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-25 13:45:03
update_time
dateTime
(required)		Timezone: GMT.
Example: 2021-11-26 11:37:25

Invoice Item

NameDescription
name
string		Name of the invoice.
Example: Ocamba Push Startup Plan (Monthly)
quantity
float
(required)		Line item quantity.
unit_price
float
(required)		Price per one unit.
price
float
(required)		Line item price (price = quantity * unit_price).
discount_rate
float
(required)		Represents a discount expressed as a percentage. Used to calculate discount.
discount
float
(required)		Line item discount (discount = price * discount_rate / 100).
tax_rate
float
(required)		Represents a tax expressed as a percentage. Used to calculate tax.
tax
float
(required)		Line item tax (tax = (price - discount) * tax_rate / 100).
amount
float
(required)		Line item amount (amount = price - discount + tax).