View App pricing details

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

Retrieves the details of a certain app pricing if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
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.


Example: fields=field1,field2,field3
viewstring
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.


Example: view=full/default
sortstring
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.


Example: sort=-field1,filed2
pagestring
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.


Example: page=1,10
typestring
Describe type of the object.


Example: type=type1
namestring
Name of the object.


Example: name=name1
create_timestring
Timezone: GMT.


Example: create_time=2021-09-14
update_timestring
Timezone: GMT.


Example: update_time=2021-09-14
planstring



Example: plan=enterprise

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ app-store ]
An array of all created items.
App Store
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-11-25 13:45:03
descriptionstring
Additional information about an app.


Example: here goes description
idstring
A unique identifier generated by the Ocamba platform.


Example: 123456789
installed_versionstring
Installed version.


Example: 2.0.28
is_publishednumber (integer)
Describes application publish status.

Possible values: 0 | 1
logostring (uri)
Represent the logo of app.


Example: https://logo-uri-example.com
namestring
Represent name of the app.


Example: adex
planobject
Plan object.
published_versionstring
Latest published version.


Example: 1.0.10
rc_versionstring
Release candidate.


Example: 2.0.1
statusstring
Describes status of the app.


Example: trial

Possible values: active | disabled | suspended | trial | trial-expired | uninstalled

Default: active
titlestring
Represent the title of the app.


Example: AdExchange
trialobject
Trial object.
typestring
Describe app type.


Example: application

Possible values: application | spa

Default: application
update_timedateTime
Timezone: GMT.


Example: 2021-11-26 11:37:25
totalinteger
A total number of items.


Example: 4
tip
1 If you don't know the app id, list apps to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "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"
             }
           ]
         }
     }
  ]
}

{
  "total": 4,
  "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"
    }
  ]
}