StatsApi
Summary
public CollectionsDto Collections()
This function will return a list of all collections in the database.
public CollectionsDto Collections( StatsUriParameterBuilder uriParameterBuilder)
This function will return a CollectionsDto object that contains a list of CollectionDto objects.
public CollectionDto Collection(string collectionName, StatsUriParameterBuilder uriParameterBuilder)
This function will return a CollectionDto object that contains the collection's name, the number of documents in the collection, the number of documents that have been deleted, the number of documents that are new (i.e. have not been persisted to disk), the number of documents that have been updated, the number of documents that have been replaced, the number of documents that have been removed, the number of documents that have been inserted, the number of documents that have been ignored, the number of documents that have been updated, the number of documents that have been replaced, the number of documents that have been removed, the number of documents that have been inserted, the number of documents that have been ignored, the number of documents that have been updated, the number of documents that have been replaced, the number of documents that have been removed, the number of documents that have been inserted, the number of documents that have been ignored, the number of documents that have been.
public AccountsDto Accounts()
This function will return a list of accounts for the current user.
public AccountsDto Accounts( StatsUriParameterBuilder uriParameterBuilder)
This function will return a list of accounts that match the criteria specified in the uriParameterBuilder parameter.
public AccountDto Account(string accountName, StatsUriParameterBuilder uriParameterBuilder)
This function will return an AccountDto object that contains the account information for the account name passed in.
This function will return the schema for the specified collection.
public SchemaDto Schema(string collectionName, StatsUriParameterBuilder uriParameterBuilder)
This function returns a schema for a given collection.
The function sends a GET request to the API and returns the response as a SalesDto object.
private readonly string _requestUriBase
private Uri CollectionsUri()
It returns a URI that points to the collections endpoint of the stats API.
private Uri CollectionsUri( IUriParameterBuilder uriParameterBuilder)
It returns a URI for the collections endpoint
private Uri CollectionUri(string collectionName, IUriParameterBuilder uriParameterBuilder)
It returns a URI for the collection stats endpoint
private Uri AccountsUri()
It returns a Uri object that represents the URL for the /stats/accounts endpoint.
private Uri AccountsUri( IUriParameterBuilder uriParameterBuilder)
It returns a URI for the /stats/accounts endpoint
private Uri AccountUri(string accountName, IUriParameterBuilder uriParameterBuilder)
It returns a URI for the account stats endpoint
private Uri SchemasUri(string collectionName)
It returns a URI for the schemas endpoint.
private Uri SchemasUri(string collectionName, IUriParameterBuilder uriParameterBuilder)
It returns a URI for the /stats/schemas/{collectionName} endpoint
private Uri GraphUri()
It returns a new Uri object that is the base request URI with the /stats/graph path appended to it.
private Uri SalesUri()
It returns a new Uri object that is the base request Uri with the /stats/sales path appended to it.
Members
public CollectionsDto Collections()
This function will return a list of all collections in the database.
Returns
A list of collections
public CollectionsDto Collections( StatsUriParameterBuilder uriParameterBuilder)
This function will return a CollectionsDto object that contains a list of CollectionDto objects.
Parameters
StatsUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A CollectionsDto object.
public CollectionDto Collection(string collectionName, StatsUriParameterBuilder uriParameterBuilder)
This function will return a CollectionDto object that contains the collection's name, the number of documents in the collection, the number of documents that have been deleted, the number of documents that are new (i.e. have not been persisted to disk), the number of documents that have been updated, the number of documents that have been replaced, the number of documents that have been removed, the number of documents that have been inserted, the number of documents that have been ignored, the number of documents that have been updated, the number of documents that have been replaced, the number of documents that have been removed, the number of documents that have been inserted, the number of documents that have been ignored, the number of documents that have been updated, the number of documents that have been replaced, the number of documents that have been removed, the number of documents that have been inserted, the number of documents that have been ignored, the number of documents that have been.
Parameters
collectionNameThe name of the collection you want to get stats for.StatsUriParameterBuilderThis is a class that allows you to build the query string parameters for the API call.
Returns
A collection of documents.
public AccountsDto Accounts()
This function will return a list of accounts for the current user.
Returns
A list of accounts
public AccountsDto Accounts( StatsUriParameterBuilder uriParameterBuilder)
This function will return a list of accounts that match the criteria specified in the uriParameterBuilder parameter.
Parameters
StatsUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A list of accounts.
public AccountDto Account(string accountName, StatsUriParameterBuilder uriParameterBuilder)
This function will return an AccountDto object that contains the account information for the account name passed in.
Parameters
accountNameThe name of the account you want to get information about.StatsUriParameterBuilderThis is a class that allows you to build the query string parameters for the API call.
Returns
An AccountDto object.
public SchemaDto Schema(string collectionName)
This function will return the schema for the specified collection.
Parameters
collectionNameThe name of the collection you want to get the schema for.
Returns
A SchemaDto object
public SchemaDto Schema(string collectionName, StatsUriParameterBuilder uriParameterBuilder)
This function returns a schema for a given collection.
Parameters
collectionNameThe name of the collection you want to get the schema for.StatsUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A SchemaDto object.
This function will return a GraphDto object that contains the graph data.
Returns
A GraphDto object
The function sends a GET request to the API and returns the response as a SalesDto object.
Returns
A SalesDto object
private readonly string _requestUriBase
private Uri CollectionsUri()
It returns a URI that points to the collections endpoint of the stats API.
private Uri CollectionsUri( IUriParameterBuilder uriParameterBuilder)
It returns a URI for the collections endpoint
Parameters
IUriParameterBuilderThis is a class that is used to build the query string parameters for the request.
private Uri CollectionUri(string collectionName, IUriParameterBuilder uriParameterBuilder)
It returns a URI for the collection stats endpoint
Parameters
collectionNameThe name of the collection you want to get stats for.IUriParameterBuilderThis is an interface that is used to build the query string parameters for the request.
private Uri AccountsUri()
It returns a Uri object that represents the URL for the /stats/accounts endpoint.
private Uri AccountsUri( IUriParameterBuilder uriParameterBuilder)
It returns a URI for the /stats/accounts endpoint
Parameters
IUriParameterBuilderThis is a class that will build the query string parameters for the request.
private Uri AccountUri(string accountName, IUriParameterBuilder uriParameterBuilder)
It returns a URI for the account stats endpoint
Parameters
accountNameThe name of the account you want to get stats for.IUriParameterBuilderThis is an interface that is used to build the query string parameters for the request.
private Uri SchemasUri(string collectionName)
It returns a URI for the schemas endpoint.
Parameters
collectionNameThe name of the collection you want to get the stats for.
private Uri SchemasUri(string collectionName, IUriParameterBuilder uriParameterBuilder)
It returns a URI for the /stats/schemas/{collectionName} endpoint
Parameters
collectionNameThe name of the collection you want to get the schema for.IUriParameterBuilderThis is a class that is used to build the query string parameters for the request.
private Uri GraphUri()
It returns a new Uri object that is the base request URI with the /stats/graph path appended to it.
private Uri SalesUri()
It returns a new Uri object that is the base request Uri with the /stats/sales path appended to it.
Last updated