Application

The Application object.

Propel Applications represent the web or mobile app you are building. They provide the API credentials that allow your client- or server-side app to access the Propel API. The Application's Propeller determines the speed and cost of your Metric Queries.

Learn more about Applications.

fields

• id non-null ID

  The Application's unique identifier.

• uniqueName non-null String

  The Application's unique name.

• description non-null String

  The Application's description.

• account non-null Account

  The Application's Account.

  The Account object.

  • account.id non-null ID

    The Account's unique identifier.

• environment non-null Environment

  The Application's Environment.

  The Environments object.

  Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.

  • environment.id non-null ID

    The Environment's unique identifier.

• createdAt non-null DateTime

  The Application's creation date and time in UTC.

• modifiedAt non-null DateTime

  The Application's last modification date and time in UTC.

• createdBy non-null String

  The Application's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.

• modifiedBy non-null String

  The Application's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.

• clientId non-null String

  The Application's OAuth 2.0 client identifier.

• secret nullable String

  The Application's OAuth 2.0 client secret.

• propeller non-null Propeller

  The Application's Propeller.

  A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

  Learn more about Data Sources.

  • P1_X_SMALL

    Max records per second: 5,000,000 records per second

  • P1_SMALL

    Max records per second: 25,000,000 records per second

  • P1_MEDIUM

    Max records per second: 100,000,000 records per second

  • P1_LARGE

    Max records per second: 250,000,000 records per second

  • P1_X_LARGE

    Max records per second: 500,000,000 records per second

• scopes non-null array of ApplicationScope

  The Application's OAuth 2.0 scopes.

  The API operations an Application is authorized to perform.

  • ADMIN

    Grant read/write access to Data Sources, Data Pools, Metrics and Policies.

  • APPLICATION_ADMIN

    Grant read/write access to Applications.

  • DATA_POOL_QUERY

    Grant read access to query Data Pools.

  • DATA_POOL_STATS

    Grant read access to fetch column statistics from Data Pools.

  • METRIC_QUERY

    Grant read access to query Metrics.

  • METRIC_STATS

    Grant read access to fetch Dimension statistics from Metrics.

  • METRIC_READ

    Grant read access to Metrics.

    This does not allow querying Metrics. For that, see METRIC_QUERY.

• dataPoolAccessPolicies non-null DataPoolAccessPolicyConnection

  A paginated list of Data Pool Access Policies associated with the Application.

  • dataPoolAccessPolicies.first optional Int

  • dataPoolAccessPolicies.after optional String

  • dataPoolAccessPolicies.last optional Int

  • dataPoolAccessPolicies.before optional String

  The Data Pool Access Policy connection object.

  Learn more about pagination in GraphQL.

  • dataPoolAccessPolicies.edges non-null array of DataPoolAccessPolicyEdge

    The Data Pool Access Policy connection's edges.

  • dataPoolAccessPolicies.nodes non-null array of DataPoolAccessPolicy

    The Data Pool Access Policy connection's nodes.

  • dataPoolAccessPolicies.pageInfo non-null PageInfo

    The Data Pool Access Policy connection's page info.

• policies non-null PolicyConnection  ⚠️ Deprecated: Use Data Pool Access Policies instead

  A paginated list of Policies associated with the Application.

  • policies.first optional Int

  • policies.after optional String

  • policies.last optional Int

  • policies.before optional String

  The Policy connection object.

  Learn more about pagination in GraphQL.

  • policies.edges non-null array of PolicyEdge

    The Policy connection's edges.

  • policies.nodes non-null array of Policy

    The Policy connection's nodes.

  • policies.pageInfo non-null PageInfo

    The Policy connection's page info.