Detailed developer documentation is available

📘

Use of this feature requires a user account with access to the setup settings, and access to an area of the setup settings that can only be granted by a NinjaCat team member. Contact a NinjaCat team member and request access to the "APPS" tab in the setup settings.

Access Credentials and Documentation

1. Go to the Setup Settings

2. Click on "Agency Settings" in the sub-navigation

3. Click on the "Apps" tab under Agency Settings

Authentication

This method allows you to get back an access token for authentication purposes when making requests in this API. You will need an Agency Identifier Key, Client Id, and Client Secret that is found in NinjaCat under the agency setting screen in the Apps Tab. If you don’t see this Apps tab, please contact your NinjaCat Account manager to request this feature. For more detailed information on this API feature view the more detailed article.

NinjaCat SSO (Single Sign-On)

Once you have obtained the above authentication to make requests through this API you can use a combination of Agency Management features to control customized, programmatic access to the NinjaCat Platform. Click for more detailed information and links to the developer documentation.

Agency Management Open API Features

The functions of the Agency Management Open API are as follows:

 

Advertiser

docs

• This method allows you to add a new advertiser account
• Functions:
  • POST Add Advertiser
  • POST Update Advertiser
  • GET Get Advertisers
  • GET Get Advertiser
  • DEL Delete Advertiser
  • POST Undelete Advertisers
• Data Model Fields:
  • name: Name of this advertiser/account
  • phone: Phone of this advertiser/account
  • company: Company name of this advertiser/account
  • email: Primary email for this advertiser/account
  • website: Website for this advertiser/account
  • external_id: An external ID that is used for matching custom data sources
  • owner_id: An id of an agency user that owns this advertiser/account
  • facebook_campaigns: A comma-separated list of Facebook campaigns to filter out when getting data for this advertiser/account for reports and dashboards
  • custom_field: This is used for the custom field placeholder found in the reporting’s email template
  • account_custom_field_values: This field is used to update account groups for this advertiser.

Advertiser Network

docs

• This method allows you to add a new advertiser network/data source
• Functions
  • POST Add Advertiser Network
  • POST Update Advertiser Networks
  • GET Get Advertiser Networks
  • GET Get Advertiser Network
  • DEL Delete Advertiser Networks 
• Data Model Fields
  • advertiser_id: The advertiser ID that indicates which advertiser this network belongs to
  • network_id: The id of the actual data source connection
  • network_definition_id: A read-only field that indicates the type of data source this is
  • network_account_id: A unique identifier that determines which account to use for an agency network data source
  • is_primary: Determine if this is the primary advertiser network to be used
  • sheet_mapping: The mapping ID that is being used for this advertiser network
  • external_advertiser_id: The advertiser id that is set to use for filtering on special custom data sources
  • earliest_reporting_date: A Datetime field to indicate the earliest data to pull for reporting and dashboards
  • latest_reporting_date: A Datetime field to indicate the latest data to pull for reporting and dashboards

Advertiser User

docs

• This method allows you to add a new advertiser user.

📘

This is the only operation where you can assign which account this advertiser belongs to.

• Functions:

  • POST Add Advertiser User
  • POST Update Advertiser User
  • GET Get Advertiser Users
  • GET Get Advertiser User
  • DEL Delete Advertiser User

• Data Model Fields:

  • username: The username that is used to login to NinjaCat
  • email: The email for this user
  • name: The actual name of this user
  • password: The password for this user
  • advertiserId: The advertiser associated with this account
  • meta_data: additional information you want to put in for this user

Agency User

docs

• allows you to add a new agency user

• Functions:

  • POST Add Agency User
  • POST Update Agency User
  • GET Get Agency Users
  • GET Get Agency User
  • DEL Delete Agency User 

• Data Model Fields:

  • username: The username that is used to login to NinjaCat
  • email: The email for this user
  • name: The actual name of this user
  • password: The password for this user
  • all_advertisers: Determine if this user has access to all the accounts for this agency
  • roles: Determine what role does this user have
  • advertisers: Determine what accounts this user has access to (if not set to all)
  • is_visible: Determine if this user is visible in the user list screen in NinjaCat
  • meta_data: additional information you want to put in for this user

Bulk Provisioning

docs

• Functions:
  • GET Get Advertisers as CSV via API
  • GET Get Reports as CSV via API
  • POST Set Reports as CSV via API
  • GET Get Data Sources as CSV via API
  • POST Set Advertisers with CSV via API
  • POST Set Data Sources with CSV via API

Custom Field

docs

• allows you to add a new Account Group field
• Functions:
  • POST Add Custom Field
  • POST Update Custom Field
  • GET Get Custom Fields
  • GET Get Custom Field
  • DEL Delete Custom Field
• Data Model Fields:
  • name : The name of the Custom Field

Custom Field Value

docs

• allows you to add a new Account Group value
• Functions: 
  • POST Add Custom Field Value
  • POST Update Custom Field Value
  • GET Get Custom Field Values
  • GET Get Custom Field Value
  • DEL Delete Custom Field Value
• Data Model Fields: 
  • name: The name of the Custom Field Value
  • custom_field_id: The id of a custom field (Account Group) this value belongs to
  • advertisers: A list of IDs for advertisers that have this Custom Field Value (Account Group Value) assigned to them

Login

docs

• The Login resource only has one operation and that is to create a login link for either an advertiser user or an agency user. This is to simulate automatic login for a user if you choose to link a user account between NinjaCat and your system
• Functions:
  • GET Get Login Link

Network

docs

• The network resource only has one operation and that is to get back a list of networks found in your agency. Essentially what a network is a connection from NinjaCat to third party data sources such as Google AdWords, Facebook Ads, etc.
• Functions:
  • GET Get Networks
  • GET Get Network Account List
• Data Model Fields:
  • id : The id of this network, is important to be used for creation of an advertiser network
  • network_definition_id : The id of a network definition, this id determines the type of network this is.
  • class_name : A string representation of the type of network.
  • tag : The display name you see in the network screen and network list screen in

Permissions

docs

• This method allows you to get back a list of permission that is available for your agency.
• Functions: 
  • GET Get Permissions
• Data Models Fields
  • id: The id of the permission, this is used to set what permission a role has
  • name: Name of the permission
  • description: Description of what the permission does

Report

docs

• This method will get back a list of reports within your agency.
• Functions:
  • GET Get Reports
  • GET Download Report
  • GET Report History
• Data Model Fields:
  • id : The unique id of this report.
  • advertiser_id : The id of the advertiser the report belongs to.
  • name : A user-friendly name for the report.
  • completed_at : The timestamp at which the report was last run.
  • date_range : The date range of time for which the report was last run.
  • download_url : The URL from which the report can be retrieved.
  • status : The status of the last report run.
  • errors : An array of error messages from the last report run, if any.

Role

docs

• This method allows you to add a new role.

  📘

  To learn more about user roles check out the article titled; Creating and Customizing User Roles

• Functions:
  • POST Add Role
  • POST Update Role
  • GET Get Roles
  • GET Get Role
  • DEL Delete Role
• Data Model Fields:
  • name : The name of the Role.
  • description : Description of the Role.
  • permissionIds : A list of permission that the role has access to. The input for this field is an array on int. Please see the Permission resource on how to obtain a list of permissions.

Mapping

docs

• The mapping resource allows for CRUD operations against the mappings belonging to networks (called "Data Sources" within the NinjaCat application)

📘

To learn more about mappings check out the article titled; Creating and Customizing User Roles

• Functions:
  • GET Get Mappings
  • GET Get Mapping
  • POST Add Mapping
  • POST Update Mapping
  • DEL Delete Mapping
• Data Model Fields
  • id: the id of the mapping
  • name: the name of the mapping (this must be unique across all data sources that have the same type)
  • network_id: the id of the network (i.e. Data Source) that the mapping belongs to