Get an overview of an App, part by part

GET

/apps/{appId}/overview

const url = 'https://api.passion.io/v1/apps/example/overview';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.passion.io/v1/apps/example/overview

Parameters

Path Parameters

appId

required

The id of the App, as Studio shows it.

string

/^[1-9][0-9]*$/

Responses

200

application/json

object

app

required

object

required

string

name

required

string

webAddress

required

Any of:

string
null

string

branding

required

object

look

required

True when the creator chose a look on the Design page.

boolean

icon

required

True when the App has an icon.

boolean

home

required

object

filled

required

The parts of the Home page that have content. Empty when none has.

Array<string>

Allowed values: tagline cover story highlights testimonials questions

courses

required

object

published

required

Courses that at least one offer gives access to.

integer

>= -9007199254740991 <= 9007199254740991

draft

required

Courses that no offer gives access to yet.

integer

>= -9007199254740991 <= 9007199254740991

offers

required

object

onSale

required

Offers that are not archived, free ones included.

integer

>= -9007199254740991 <= 9007199254740991

subscriptions

required

object

live

required

Active and trialing subscriptions, the free access plan left out.

integer

>= -9007199254740991 <= 9007199254740991

byOffer

required

Array<object>

object

offerId

required

string

name

required

string

live

required

integer

>= -9007199254740991 <= 9007199254740991

last30Days

required

object

started

required

Subscriptions created in the last 30 days.

integer

>= -9007199254740991 <= 9007199254740991

ended

required

Subscriptions that stopped in the last 30 days.

integer

>= -9007199254740991 <= 9007199254740991

communities

required

Array<object>

object

required

string

name

required

string

members

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

channels

required

The channels of the community. Posts go into a channel.

Array<object>

object

required

string

name

required

string

assistant

required

Any of:

object
null

object

name

required

Any of:

string
null

string

Example

{
  "home": {
    "filled": [
      "tagline"
    ]
  }
}