{"source":"ssb","operation":"get_table_metadata","description":"Get dimensions, value codes, labels, units and periods for an SSB table. Signature: get_table_metadata(table_id: string, required; lang: string, optional, default 'no'; value_filter: string, optional, default None; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"get_table_metadata(table_id: string, required; lang: string, optional, default 'no'; value_filter: string, optional, default None; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"table_id","type":"string","schema":{"type":"string"},"required":true,"default":null,"description":"Five-digit Statbank table id, e.g. \"07459\".","unit":null},{"name":"lang","type":"string","schema":{"type":"string"},"required":false,"default":"no","description":"Metadata language, \"no\" or \"en\".","unit":null},{"name":"value_filter","type":"string","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false,"default":null,"description":"Optional case-insensitive substring to filter each dimension's values by code or label, e.g. \"Gloppen\" or \"0301\". Use this instead of paging through a ~980-row municipality list for a single place. It also surfaces renumbered codes for free: SSB keeps a retired code in the list (e.g. \"Gloppen (-2019)\") alongside its replacement (\"Gloppen\", code 4650 since 2020), so both show up in one call.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100).","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/ssb/get_table_metadata?table_id={table_id}&lang=no&value_filter={value_filter}&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"version":{"type":["string","null"]},"class":{"type":["string","null"]},"label":{"type":["string","null"]},"source":{"type":["string","null"]},"updated":{"type":["string","null"],"format":"date-time"},"note":{"type":["array","null"],"items":{"type":"string"}},"role":{"type":["object","null"]},"id":{"type":"array","items":{"type":"string"}},"size":{"type":"array","items":{"type":"integer"}},"dimension":{"type":"object"},"value":{"type":["array","null"],"items":{"type":["number","null"]}},"extension":{"type":["object","null"]},"link":{"type":["object","null"]}},"required":["class","dimension"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["statistical_table"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/ssb/get_table_metadata/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/ssb/get_table_metadata","source":"https://allemannsdata.com/wiki/api/v1/kilder/ssb","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["version","class","label","source","updated","note","role","id","size","dimension","value","extension","link"],"output_fields_truncated":false,"canonical_field_aliases":{"name":["label"],"identifier":["id"]},"response_example":{"source":"ssb","operation":"get_table_metadata","parameters":{"table_id":"example-id","lang":"no","value_filter":"example value"},"data":{"version":"example value","class":"example value","label":"Example","source":"example value","updated":"2026-01-15T12:00:00Z","note":["example value"],"role":{},"id":["example-id"],"size":[1],"dimension":{},"value":[1.0],"extension":{},"link":{}},"entities":[{"type":"statistical_table","id":"example-id","source":"ssb","description":"Statistical table used as the operation input."}],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"ssb","name":"Statistics Norway","description":"Search Statbank and fetch table metadata, dimensions, units and statistics in JSON-stat2.","cache_ttl_seconds":300,"documentation":"https://www.ssb.no/api/pxwebapiv2"}]},"_provenance":{"data":{"source":"ssb","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/ssb"},"entities":{"source":"ssb","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/ssb","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/ssb/get_table_metadata","source":"https://allemannsdata.com/wiki/api/v1/kilder/ssb","wiki":"https://allemannsdata.com/wiki/kilder/ssb/get_table_metadata/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}
