View App

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

Retrieves the details of a certain App 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

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ app ]
An array of all created items.
App
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
logostring (uri)
Represent the logo of app.


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


Example: adex
planstring
Represent the pricing plan.


Example: '{ "features" : ["billing"] }'
titlestring
Represent the title of the app.


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

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