Connectors Reference

Appfigures

Appfigures is a reporting platform for mobile app developers. It brings together all of your app store sales, ad data, worldwide reviews, and hourly rank updates based off of the available reports from your synced accounts.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

GetMyProducts ()

Get my products

SearchRatings ([Optional]string products)

Get ratings snapshots

SearchReviews ([Optional]string products)

Get reviews

SearchEvents ()

Get events

 

Triggers:

Name

Summary

OnNewEvent ()

When an event occurs

OnNewReview ([Optional]string products)

When there is a new review

OnNewRating ([Optional]string products)

When an app is rated

 

Objects:

Name

Summary

Event

 

MyProduct

 

MyProductsResponse

 

Rating

 

Review

 

 

Actions:

GetMyProducts

Summary: Get my products

Description: Returns a list of products for the current user.

 

Syntax:

Appfigures.GetMyProducts ()

 

Returns:

          Type:MyProductsResponse

          Description: Stores tracked by Appfigures

 

SearchRatings

Summary: Get ratings snapshots

Description: Get an app's ratings snapshot for a given region and date with a few filters.

 

Syntax:

Appfigures.SearchRatings ([Optional]string products)

 

Parameters:

Name

Type

Summary

Required

Related Action

products

string

(Product Id)

The unique ID of a product in Appfigures.

False

GetMyProducts

 

Returns:

          Type:array of (Rating)

 

SearchReviews

Summary: Get reviews

Description: Get an app's reviews with a variety of filters, as well as review count breakdowns.

 

Syntax:

Appfigures.SearchReviews ([Optional]string products)

 

Parameters:

Name

Type

Summary

Required

Related Action

products

string

(Product Id)

The unique ID of a product in Appfigures.

False

GetMyProducts

 

Returns:

          Type:array of (Review)

 

SearchEvents

Summary: Get events

Description: Get the events for the apps in the current account.

 

Syntax:

Appfigures.SearchEvents ()

 

Returns:

          Type:array of (Event)

 

Triggers:

Trigger OnNewEvent

Summary: When an event occurs

Description: Trigger an action on an event for the apps in the current account.

 

Syntax:

Appfigures.OnNewEvent ()

 

Returns:

          Type:array of (Event)

 

Trigger OnNewReview

Summary: When there is a new review

Description: Trigge an action when there is a new review.

 

Syntax:

Appfigures.OnNewReview ([Optional]string products)

 

Parameters:

Name

Type

Summary

Required

Related Action

products

string

(Product Id)

The unique ID of a product in Appfigures.

False

GetMyProducts

 

Returns:

          Type:array of (Review)

 

Trigger OnNewRating

Summary: When an app is rated

Description: Trigger an action when an app is rated.

 

Syntax:

Appfigures.OnNewRating ([Optional]string products)

 

Parameters:

Name

Type

Summary

Required

Related Action

products

string

(Product Id)

The unique ID of a product in Appfigures.

False

GetMyProducts

 

Returns:

          Type:array of (Rating)

 


 

Event

Summary:

Description: Event data for a product tracked by Appfigures

 

          Properties:

Name

Type

Summary

id

string

Event Id

The Id of the event

caption

string

Caption

The caption of the event

date

string(date-time)

Date

The date for the event

origin

string

Origin

The origin of the event

details

string

Details

The details of the event

products

array of (string)

Products

The products relevant to the event


 

MyProduct

Summary:

Description: A Product belonging to my account

 

          Properties:

Name

Type

Summary

id

string

Product Id

Id of your product

name

string

Product Name

Name of your product

developer

string

Developer

Developer of your product

store

string

Store

The store this product belongs to

release_date

string(date-time)

Release Date

Release date of your product

updated_date

string(date-time)

Updated Date

Updated date of your product

version

string

Version

Version of your product


 

MyProductsResponse

Summary:

Description: Stores tracked by Appfigures

 

          Properties:

Name

Type

Summary

products

array of (MyProduct)

Products

Collection Of Products


 

Rating

Summary:

Description: Rating data for a product tracked by Appfigures

 

          Properties:

Name

Type

Summary

product

string

Product Id

The Id of the product this rating is for

region

string

Region

The country or language for this rating snapshot

date

string(date-time)

Date

The date for this rating snapshot

oneStar

integer(int32)

One Star Reviews

The number of one-star reviews for the product at the time of the snampshot

twoStar

integer(int32)

Two Star Reviews

The number of two-star reviews for the product at the time of the snampshot

threeStar

integer(int32)

Three Star Reviews

The number of three-star reviews for the product at the time of the snampshot

fourStar

integer(int32)

Four Star Reviews

The number of four-star reviews for the product at the time of the snampshot

fiveStar

integer(int32)

Five Star Reviews

The number of five-star reviews for the product at the time of the snampshot


 

Review

Summary:

Description: A review of an app tracked by Appfigures

 

          Properties:

Name

Type

Summary

author

string

Author

The name of the author that left this review

title

string

Title

The title of the review; if a translation language has been provided this will hold the translated title

review

string

Review

The full review

original_title

string

Original Title

If a translation language has been provided this will hold the original title before translation

original_review

string

Original Review

If a translation language has been provided this will hold the original review before translation

stars

integer(int32)

Stars

Number of stars the author left for the app.

iso

string

Country Code

The country code where this review was observed.

version

string

Version

The version of the app this review is for (Note: not all app stores support app version in reviews)

date

string(date-time)

Date

Date the review was left on the store

product

string

Product Id

The ID of the product this review belongs to

id

string

Review Id

A unique ID for this review