Custom API Template: .JSON.Array fails to access array directly under top-level key using path #597

kassyss · 2025-04-19T13:29:05Z

kassyss
Apr 19, 2025

Description

I'm encountering an issue with the Custom API template feature in Glance when trying to display data from a JSON response where the main list/array is located directly under a top-level key.

The template syntax .JSON.Array "path.to.array" works correctly when the array is nested within another object. However, it fails when the array is the direct value of a key at the top level of the data object returned by the API.

Expected Behavior

The template expression {{ len (.JSON.Array "data") }} should return the number of items in the array located at the path "data", and {{ range .JSON.Array "data" }} should iterate over the elements of this array when the API response is {"data": [...]}.

Actual Behavior

When the JSON response contains the array directly under the "data" key, as shown in the "Failing Scenario" below:

{{ len (.JSON.Array "data") }} returns 0.
{{ range .JSON.Array "data" }} does not iterate.

Steps to Reproduce

Configure a Custom API endpoint that returns a JSON response structured like the "Failing Scenario (DNS Records)" example below (array directly under the "data" key).
Create a Custom API template using the {{ len (.JSON.Array "data") }} and {{ range .JSON.Array "data" }} syntax as shown in the failing template example.
Observe the output in the Glance dashboard; the count will be 0 and the items will not be displayed.

Illustrative Examples

Working Scenario (Signatures - array nested):

This scenario works correctly, where the array "signatures" is nested within the object "data".

Full API Response JSON:

{
  "result": "success",
  "data": {
    "signatures": [ // Array is nested
      {
        "id": 2148253,
        "name": "zoubida",
        "fullname": "zoubido",
        "full_name": "zoubido",
        "content": "<div><br /></div>",
        "position": "bottom",
        "filled_at": 1739744654,
        "is_auto": false,
        "is_default": false,
        "sender": "[email protected]",
        "sender_idn": "[email protected]",
        "sender_id": 0,
        "reply_to": "[email protected]",
        "reply_to_idn": "[email protected]",
        "reply_to_id": 0,
        "has_infomaniak_footer": false,
        "template": null
      },
      {
        "id": 2148254,
        "name": "zoubido",
        "fullname": "zoubido",
        "full_name": "zoubido",
        "content": "<div><br /></div>",
        "position": "bottom",
        "filled_at": 1739744797,
        "is_auto": false,
        "is_default": false,
        "sender": "[email protected]",
        "sender_idn": "[email protected]",
        "sender_id": 0,
        "reply_to": "[email protected]",
        "reply_to_idn": "[email protected]",
        "reply_to_id": 0,
        "has_infomaniak_footer": false,
        "template": null
      },
      {
        "id": 2148255,
        "name": "Atartempio",
        "fullname": "zoubido tartempio",
        "full_name": "zoubido tartempio",
        "content": "<div><br /></div>",
        "position": "bottom",
        "filled_at": 1739744892,
        "is_auto": false,
        "is_default": false,
        "sender": "[email protected]",
        "sender_idn": "[email protected]",
        "sender_id": 0,
        "reply_to": "[email protected]",
        "reply_to_idn": "[email protected]",
        "reply_to_id": 0,
        "has_infomaniak_footer": false,
        "template": null
      },
      {
        "id": 2148256,
        "name": "Chkoun",
        "fullname": "zoubido",
        "full_name": "zoubido",
        "content": "<div><br /></div>",
        "position": "bottom",
        "filled_at": 1739744965,
        "is_auto": false,
        "is_default": true,
        "sender": "[email protected]",
        "sender_idn": "[email protected]",
        "sender_id": 0,
        "reply_to": "[email protected]",
        "reply_to_idn": "[email protected]",
        "reply_to_id": 0,
        "has_infomaniak_footer": false,
        "template": null
      },
      {
        "id": 2148257,
        "name": "Amazon",
        "fullname": "zoubido",
        "full_name": "zoubido",
        "content": "<div><br /></div>",
        "position": "bottom",
        "filled_at": 1739745016,
        "is_auto": false,
        "is_default": false,
        "sender": "[email protected]",
        "sender_idn": "[email protected]",
        "sender_id": 0,
        "reply_to": "[email protected]",
        "reply_to_idn": "[email protected]",
        "reply_to_id": 0,
        "has_infomaniak_footer": false,
        "template": null
      }
    ]
  }
}

Working Template Code:

<div>
  <b>{{ len (.JSON.Array "data.signatures") }} signatures</b>
  <br />
  <br />
  <ul class="list list-gap-10 collapsible-container" data-collapse-after="0">
  {{ range .JSON.Array "data.signatures" }}
    <p class="signatures-item">{{ .String "sender" }} ({{ .String "fullname" }})</p>
  {{ end }}
  </ul>
</div>

Result: Correctly displays the count and iterates over signature items.

Failing Scenario (DNS Records - array directly under key):

This scenario fails when the array is the direct value of the "data" key.

Full API Response JSON:

{
  "result": "success",
  "data": [ // Array is directly under "data"
    {
      "id": 24315007,
      "source": ".",
      "type": "NS",
      "ttl": 3600,
      "target": "ns11.ovh.ch",
      "updated_at": 1739731419
    },
    {
      "id": 24315008,
      "source": ".",
      "type": "NS",
      "ttl": 3600,
      "target": "ns12.ovh.ch",
      "updated_at": 1739731419
    },
    {
      "id": 24315015,
      "source": "_dmarc",
      "type": "TXT",
      "ttl": 3600,
      "target": "\"v=DMARC1; p=reject;\"",
      "updated_at": 1739731420
    },
    {
      "id": 24315032,
      "source": "_domainkey",
      "type": "NS",
      "ttl": 3600,
      "target": "ns11.ovh.ch",
      "updated_at": 1739731550
    },
    {
      "id": 24315033,
      "source": "_domainkey",
      "type": "NS",
      "ttl": 3600,
      "target": "ns12.ovh.ch",
      "updated_at": 1739731550
    },
    {
      "id": 24315034,
      "source": ".",
      "type": "MX",
      "ttl": 3600,
      "target": "5 mta-gw.ovh.ch",
      "updated_at": 1739731551
    },
    {
      "id": 24315038,
      "source": ".",
      "type": "TXT",
      "ttl": 3600,
      "target": "\"v=spf1 include:spf.ovh.ch -all\"",
      "updated_at": 1739731552
    },
    {
      "id": 24315039,
      "source": "autoconfig",
      "type": "CNAME",
      "ttl": 3600,
      "target": "ovh.com",
      "updated_at": 1739731553
    },
    {
      "id": 24315040,
      "source": "autodiscover",
      "type": "CNAME",
      "ttl": 3600,
      "target": "ovh.com",
      "updated_at": 1739731553
    },
    {
      "id": 25315883,
      "source": "titi",
      "type": "A",
      "ttl": 3600,
      "target": "82.64.205.194",
      "updated_at": 1744050789
    },
    {
      "id": 25315905,
      "source": "*.tita",
      "type": "CNAME",
      "ttl": 3600,
      "target": "titi.zoubida.fr",
      "updated_at": 1744050973
    },
    {
      "id": 25315914,
      "source": "tita",
      "type": "CNAME",
      "ttl": 3600,
      "target": "zoubida.tarita.com",
      "updated_at": 1744051026
    },
    {
      "id": 25315957,
      "source": "tigqsdf",
      "type": "CNAME",
      "ttl": 3600,
      "target": "zoubida.tarita.com",
      "updated_at": 1744051258
    }
  ]
}

Failing Template Code:

<div>
  <b>{{ len (.JSON.Array "data") }} records</b> {# Fails, returns 0 #}
  <br />
  <br />
  <ul class="list list-gap-10 collapsible-container" data-collapse-after="0">
  {{ range .JSON.Array "data" }} {# Fails, does not iterate #}
    <p class="signatures-item">{{ .String "type" }} ({{ .String "target" }})</p>
  {{ end }}
  </ul>
</div>

Result: Displays "0 records" and the range loop is skipped.

Or maybe there is another way do so?

Best regards

Answered by svilenmarkov

Apr 19, 2025

~~Hey, to access a top-level value or the value of the current context, use an empty string as the key:~~

{{ range .JSON.Array "" }}

~~This is documented here. I know it's not the most intuitive thing at first, but I didn't want to introduce a separate function just for this case.~~

I think I may have misunderstood the issue initially. I tried replicating with the data and template you provided, but it's working as expected:

It looks broken since you've specified data-collapse-after="0", but if you change it to 5 for example and remove the comments, you get what you expect:

Can you add the following to your template to verify that you're getting the expected response?

{{ .Response.StatusCode }}…

View full answer

svilenmarkov · 2025-04-19T15:20:54Z

svilenmarkov
Apr 19, 2025
Maintainer

~~Hey, to access a top-level value or the value of the current context, use an empty string as the key:~~

{{ range .JSON.Array "" }}

~~This is documented here. I know it's not the most intuitive thing at first, but I didn't want to introduce a separate function just for this case.~~

I think I may have misunderstood the issue initially. I tried replicating with the data and template you provided, but it's working as expected:

It looks broken since you've specified data-collapse-after="0", but if you change it to 5 for example and remove the comments, you get what you expect:

Can you add the following to your template to verify that you're getting the expected response?

{{ .Response.StatusCode }}
{{ .JSON.String "" }}

It should output the status code and response body.

1 reply

kassyss Apr 19, 2025
Author

Hi @svilenmarkov, thank you very much for your quick answer.

I have tested with the syntax you provided (thanks also for the explanations), but using this template :

<div>
  <b>{{ len (.JSON.Array "") }} records</b> {# Fails, returns 0 #}
  <br />
  <br />
  <ul class="list list-gap-10 collapsible-container" data-collapse-after="0">
  {{ range .JSON.Array "" }} {# Fails, does not iterate #}
    <p class="dsnrecords-item">{{ .String "type" }} ({{ .String "target" }})</p>
  {{ end }}
  </ul>
</div>

Glance dashboard shows "1 records" and doesn't show anything about type and target for each record.....

Reading the documentation, the example that is very similar to the previous output (curl) i provided is (i think) this one

{
  "author": "John Doe",
  "posts": [
    {
      "title": "My Title",
      "content": "My Content"
    },
    {
      "title": "My Title 2",
      "content": "My Content 2"
    }
  ]
}


{{ range .JSON.Array "posts" }}
  <div>{{ .String "title" }}</div>
  <div>{{ .String "content" }}</div>
{{ end }}

a simplified ouput of the previous curl

{
  "result": "success",
  "data": [
    {
      "id": 24315007,
      "source": ".",
      "type": "NS",
      "ttl": 3600,
      "target": "ns11.ovh.ch",
      "updated_at": 1739731419
    },
    {
      "id": 24315008,
      "source": ".",
      "type": "NS",
      "ttl": 3600,
      "target": "ns12.ovh.ch",
      "updated_at": 1739731419
    },
    {
      "id": 24315015,
      "source": "_dmarc",
      "type": "TXT",
      "ttl": 3600,
      "target": "\"v=DMARC1; p=reject;\"",
      "updated_at": 1739731420
    }
  ]
}

and adapting the template as below seems identical to the provided example in the documentation?

{{ range .JSON.Array "data" }}
  <div>{{ .String "type" }}</div>
  <div>{{ .String "target" }}</div>
{{ end }}

Sorry for my ignorance.....

Best regards

kassyss · 2025-04-19T16:06:15Z

kassyss
Apr 19, 2025
Author

@svilenmarkov , my baaaaad !
Using this as template
{{ .Response.StatusCode }}
{{ .JSON.String "" }}

clearly showed me that the Authorization key i was using didn't allow to parse the api for retrieving dns records (permission issue)! i didn't use the Authorization i was using with curl and Bruno.............

now using the initial template is working :)

              <div>
                <!-- Liste des alias -->
                <b>{{ len ( .JSON.Array "data" ) }} records</b>
                <br />
                <br />
                <ul class="list list-gap-10 collapsible-container" data-collapse-after="0">
                {{ range .JSON.Array "data" }}
                  <p class="signatures-item">{{ .String "type" }} ({{ .String "target" }})</p>
                {{ end }}
                </ul>
              </div>

Thank you very much for your helpful hint, i am learning every day :)

Have a nice week-end

1 reply

svilenmarkov Apr 19, 2025
Maintainer

No worries, glad you figured it out!

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom API Template: .JSON.Array fails to access array directly under top-level key using path #597

{{title}}

Replies: 2 comments 2 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

Select a reply

Custom API Template: .JSON.Array fails to access array directly under top-level key using path #597

kassyss Apr 19, 2025

Replies: 2 comments · 2 replies

svilenmarkov Apr 19, 2025 Maintainer

kassyss Apr 19, 2025 Author

kassyss Apr 19, 2025 Author

svilenmarkov Apr 19, 2025 Maintainer

kassyss
Apr 19, 2025

Replies: 2 comments 2 replies

svilenmarkov
Apr 19, 2025
Maintainer

kassyss Apr 19, 2025
Author

kassyss
Apr 19, 2025
Author

svilenmarkov Apr 19, 2025
Maintainer