Retrieve an App

GET /app-store/{app_id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/app-store/{app_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-store ]

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



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

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