The Connector supports the following actions:
- Get - Returns a single record for a specified internal ID.
- Find - Returns a list of records.
- Save - Creates a new record.
- Update - Modifies a single existing record.
- Delete - Removes a single existing record.
Note: Not all actions are available for every record type.
Record Type Overview
Most of the data exchanged with OpSource Analytics are statistical records representing various business and technical metrics such as logins and applications events to be reported on later. Several important data objects are Customer Metrics, Units, Events, and Logins. These records provide the data for the majority of reporting.
Some OpSource records (such as "Customer Metrics, "Unit", and "Event") are generic, meaning the user can define different kinds or categories of Units or Events. Examples of different kinds of Units might be new registrations, business transactions, or specific user actions. These categories of values are referred to as "types". When creating or querying these records, you will specify a value for the type field.
For user-defined values, you should use the "Customer Metric" record type.
Getting Data from OpSource Analytics
When requesting data from OpSource (via a "Get" or "Find" action), you will typically need specify one or more input parameters to function as selection criteria. These inputs are defined in the Request XML Profile and are named like in0. You will provide values for these inputs as Connector Call Parameters. Click here for more information on setting Parameter values.
- "Get" requests have one input (in0) that represents the internal ID of the record to return.
- "Find by type" requests have one input (in0) that represents the name of the type of records to return.
- "Find by range" requests have two inputs (in0, in1) that represent start and end timestamps, respectively, of records to return.
- "Find by type and range" requests have three inputs (in0, in1, in2) that represent the name of the type, start and end timestamps, respectively, of records to return.
Sending Data to OpSource Analytics
There are several important fields to note when saving/updating records, especially Units, Events, and Logins. When applicable, these fields are all required. All records are time-sensitive so the start and end timestamps are required.
- count - Numeric value of the record. This is the actual value of the statistic you are capturing.
- metricid - Numeric unique ID for the record. You can provide an external ID or let OpSource generate one for you.
- type - User-defined "type" of record. This value should be used consistently for a given type of data.
- timeStampBegin - Start period associated with the record.
- timeStampEnd - End period associated with the record.
OpSource Date/Time elements should be configured with the following format: