Skip to main content

ApplicationResponse

The result of a mutation which creates or modifies an Application.

fields

  • application nullable Application

    The Application which was created or modified.

    The Application object.

    Applications represent the web or mobile app you are building. They are OAuth 2.0 clients that give you scoped access to the Propel API.

    The Application's Propeller determines the compute power assigned to the Application: the larger the Propeller, the faster the queries.

    We recommend every web or mobile app to be its own Propel Application.

    • application.id non-null ID

      The Application's unique identifier.

    • application.uniqueName non-null String

      The Application's unique name.

    • application.description non-null String

      The Application's description.

    • application.account non-null Account

      The Application's Account.

    • application.environment non-null Environment

      The Application's Environment.

    • application.createdAt non-null DateTime

      The Application's creation date and time in UTC.

    • application.modifiedAt non-null DateTime

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

    • application.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.

    • application.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.

    • application.clientId non-null String

      The Application's OAuth 2.0 client identifier.

    • application.secret nullable String

      The Application's OAuth 2.0 client secret.

    • application.propeller non-null Propeller

      The Application's Propeller.

      A Propeller defines the compute power assigned to a Propel Application. The larger its compute power, the faster the queries. With Propellers, you can assign different compute powers (and cost profiles) to different use cases or workloads (with the same data).

      Propellers have the following properties:

      Max RPS: The maximum number of records per second (RPS) that can be processed by the Propeller on a single query.

      • 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

    • application.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 and Metrics.

      • METRIC_QUERY

        Grant read access to query Metrics.

      • METRIC_STATS

        Grant read access to fetch Dimension statistics from Metrics.

    • application.policies non-null PolicyConnection

      A paginated list of Policies associated with the Application.