Skip to main content
GET
/
datasets
/
{dataset_id}
/
statistics-configuration
Get Statistics Configuration
curl --request GET \
  --url https://api-dev.narrative.io/datasets/{dataset_id}/statistics-configuration \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dataset_id": 123,
  "version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "configuration": {
    "defaults": {
      "enabled_stats": [
        "value_count"
      ],
      "stat_options": {
        "histogram": {
          "max_bins": 50,
          "overflow": "none"
        }
      }
    },
    "refresh": {
      "trigger": "cron",
      "cron_expression": "<string>"
    },
    "dataset": {
      "scope": {
        "enabled_stats": [
          "value_count"
        ],
        "stat_options": {
          "histogram": {
            "max_bins": 50,
            "overflow": "none"
          }
        }
      },
      "fields": [
        {
          "field_name": "<string>",
          "enabled_stats": [
            "value_count"
          ],
          "stat_options": {
            "histogram": {
              "max_bins": 50,
              "overflow": "none"
            }
          },
          "self": {
            "enabled_stats": [
              "value_count"
            ],
            "stat_options": {
              "histogram": {
                "max_bins": 50,
                "overflow": "none"
              }
            }
          },
          "properties": [
            {
              "path": "<string>",
              "enabled_stats": [
                "value_count"
              ],
              "stat_options": {
                "histogram": {
                  "max_bins": 50,
                  "overflow": "none"
                }
              },
              "self": {
                "enabled_stats": [
                  "value_count"
                ],
                "stat_options": {
                  "histogram": {
                    "max_bins": 50,
                    "overflow": "none"
                  }
                }
              },
              "properties": "<array>",
              "items": {
                "enabled_stats": [
                  "value_count"
                ],
                "stat_options": {
                  "histogram": {
                    "max_bins": 50,
                    "overflow": "none"
                  }
                },
                "self": {
                  "enabled_stats": [
                    "value_count"
                  ],
                  "stat_options": {
                    "histogram": {
                      "max_bins": 50,
                      "overflow": "none"
                    }
                  }
                },
                "properties": "<array>",
                "items": "<unknown>"
              }
            }
          ],
          "items": {
            "enabled_stats": [
              "value_count"
            ],
            "stat_options": {
              "histogram": {
                "max_bins": 50,
                "overflow": "none"
              }
            },
            "self": {
              "enabled_stats": [
                "value_count"
              ],
              "stat_options": {
                "histogram": {
                  "max_bins": 50,
                  "overflow": "none"
                }
              }
            },
            "properties": "<array>",
            "items": "<unknown>"
          }
        }
      ]
    },
    "rosetta_stone": {
      "scope": {
        "enabled_stats": [
          "value_count"
        ],
        "stat_options": {
          "histogram": {
            "max_bins": 50,
            "overflow": "none"
          }
        }
      },
      "fields": [
        {
          "attribute_name": "<string>",
          "enabled_stats": [
            "value_count"
          ],
          "stat_options": {
            "histogram": {
              "max_bins": 50,
              "overflow": "none"
            }
          },
          "self": {
            "enabled_stats": [
              "value_count"
            ],
            "stat_options": {
              "histogram": {
                "max_bins": 50,
                "overflow": "none"
              }
            }
          },
          "properties": [
            {
              "path": "<string>",
              "enabled_stats": [
                "value_count"
              ],
              "stat_options": {
                "histogram": {
                  "max_bins": 50,
                  "overflow": "none"
                }
              },
              "self": {
                "enabled_stats": [
                  "value_count"
                ],
                "stat_options": {
                  "histogram": {
                    "max_bins": 50,
                    "overflow": "none"
                  }
                }
              },
              "properties": "<array>",
              "items": {
                "enabled_stats": [
                  "value_count"
                ],
                "stat_options": {
                  "histogram": {
                    "max_bins": 50,
                    "overflow": "none"
                  }
                },
                "self": {
                  "enabled_stats": [
                    "value_count"
                  ],
                  "stat_options": {
                    "histogram": {
                      "max_bins": 50,
                      "overflow": "none"
                    }
                  }
                },
                "properties": "<array>",
                "items": "<unknown>"
              }
            }
          ],
          "items": {
            "enabled_stats": [
              "value_count"
            ],
            "stat_options": {
              "histogram": {
                "max_bins": 50,
                "overflow": "none"
              }
            },
            "self": {
              "enabled_stats": [
                "value_count"
              ],
              "stat_options": {
                "histogram": {
                  "max_bins": 50,
                  "overflow": "none"
                }
              }
            },
            "properties": "<array>",
            "items": "<unknown>"
          }
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
dataset_id
integer
required

Unique identifier for a dataset.

Response

OK

Full statistics configuration entity with metadata. Returned by both PUT (create/update) and GET endpoints.

​
id
string<uuid>
required

Unique identifier for this configuration version.

​
dataset_id
integer<int64>
required

The dataset this configuration belongs to.

​
version
integer<int32>
required

Monotonically increasing version number.

​
created_at
string<date-time>
required

Timestamp when this configuration version was created.

​
created_by
integer<int64>
required

User ID of the user who created this configuration version.

​
configuration
object
required

The full statistics configuration payload.