ProjectExplorationContext Data Type

Properties
name data type description
columnHeaderId number The id of the columnHeader that you wish to analyze. This should be one of the columns of the project.
language string The language in the chosen column. Should be an iso code from the list of supported languages that can be found at developer.gavagai.se.
topicsPageSize number Number of topics to return in an exploration. Default is 30.
associationsPageSize number The number of associations to return for each topic. Default is 10.
ignoreTerms array of string The terms to be ignored. These will not be considered as candidates for topics, although they can still become associations.
filters array of Filter You may filter using columns other than the one which is being analyzed. Supply filters here as specified in the Filter type.
groups array of TopicGroupRequest Specify your groups here. It is necessary to specify a group in this list if it has been modified in any way, such as if it is pinned or its title has been changed. You may send in other groups as well without adverse effects.
acceptOverageToken string Set this property if you have no credits left but still want to explore your project. There will be an one-time charge to your credit card with the amount overage * priceUnitInCent + VAT You can always change the subscription billing plan if you want to raise you credit limit
conceptFilter ConceptFilter You may filter using concepts.
calculateGraphData boolean Set this property if you want the exploration to generate graph data

Example

{
  "columnHeaderId" : 12345,
  "language" : "...",
  "topicsPageSize" : 12345,
  "associationsPageSize" : 12345,
  "ignoreTerms" : [ "...", "..." ],
  "filters" : [ {
    "value" : "...",
    "operator" : "BIGGER_THAN",
    "columnHeaderId" : 12345,
    "valueFormat" : "..."
  }, {
    "value" : "...",
    "operator" : "BIGGER_THAN_EQUAL",
    "columnHeaderId" : 12345,
    "valueFormat" : "..."
  } ],
  "groups" : [ {
    "title" : "...",
    "topics" : [ {
      "terms" : [ "...", "..." ],
      "sticky" : true,
      "title" : "..."
    }, {
      "terms" : [ "...", "..." ],
      "sticky" : true,
      "title" : "..."
    } ],
    "pinned" : true
  }, {
    "title" : "...",
    "topics" : [ {
      "terms" : [ "...", "..." ],
      "sticky" : true,
      "title" : "..."
    }, {
      "terms" : [ "...", "..." ],
      "sticky" : true,
      "title" : "..."
    } ],
    "pinned" : true
  } ],
  "acceptOverageToken" : "...",
  "conceptFilter" : {
    "conceptId" : 12345,
    "inclusive" : true,
    "filtered" : true
  },
  "calculateGraphData" : true
}