The PYLON Glossary contains terms and vocabulary used frequently to talk about features and aspects of our platform. Following each definition are links to related articles in our documentation for further exploration of each term.
Analysis results - The data returned from an Analysis Query.
API - Application programming interface. If you write external code that works alongside DataSift, it will communicate with DataSift via calls to our REST API.
API key - A unique identifier for your DataSift account. To access our platform via its API, you need to have a DataSift account and an API key.
Argument - A user-defined value that is used by an operator and tested against a target. For example, the argument in this filter is "iPad":
Augmentation - A source of extra metadata added to an interaction by the platform.
Client library - Code supplied by DataSift or by a third party that you can use to access our API easily. You can write programs that hit the API directly (in fact, that exactly what the client libraries do) but it's easier to write code that communicates with DataSift's API via a client library.
CSDL - Curated Stream Definition Language - The platform language used to match attributes of interactions.
Engagements - Comments, likes, and reshares associated with a story.
Facebook topic data - The information received from Facebook by our platform.
Filter - Code written in CSDL defining a DataSift filter. A filter consists of one or more conditions. Each condition consists of a Target, an Operator and (nearly always) an optional Argument. The condition returns a Boolean value. A filter can consist of just one condition such as:
However, it usually comprises multiple conditions linked together with logical operators.
Index - Data storage for the result of an interaction filter. When you run an interaction filter it records its results to an index. You cannot see the interactions in the index but you can run query filters to perform secondary CSDL filtering on the data and you can perform analysis queries to analyze the data in the index.
Interaction - A single object such as a Facebook story or a like.
Interaction filter - Contains the conditions that identify which interactions should be recorded to an index.
Logical Operator - The logical operators are used to determine the result of a filter definition. The three supported logical operators are AND, OR and NOT. Using these in combination, it is easy to fashion other operators; for example: you can implement NAND using AND and NOT together.
Operator - A keyword that appears in an CSDL filter. The simplest filters consist of a target, an operator and (nearly always) an optional argument. An operators compares an argument you supply against a target you select. For example, the CSDL operator in this filter is "contains" and it filters for occurances of "iPad" in the body of a story:
Quantization - The rounding down of Analysis Results to ensure privacy is maintained.
Query Filter - A method of filtering which interactions in a recording are made available to an Analysis Query.
Redaction - The removal of data from Analysis Results to ensure privacy is maintained.
Target - The identifier for an attribute of an interaction. An element that you can filter on using the CSDL language. The simplest filters consist of a target, an operator and (nearly always) an optional argument. For example, the CSDL operator in this filter is fb.content:
Type - Every target has a single data type. The type can be "string", "int", "float", or an array of one of these types.