Export Map - Plugixa Image Map for WordPress

Export Map - Plugixa Image Map

GET /plugixa-image-map/v1/maps/{id}/export

The map as an export file, ready to save as JSON and bring into another site with Import Map File.

Any signed-in user with the plugixa_image_map_export capability. Administrators have every Plugixa Image Map capability; see Roles and permissions.

Request

GET https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/export

Path parameters

Name	Type	Description
`id`	`integer`	The map’s id

Responses

`200` OK. `data` is the export file.

{
  "success": true,
  "data": {
    "format": "plugixa-image-map",
    "format_version": 1,
    "generator": "Plugixa Image Map 1.0.0",
    "exported_at": "2026-11-12T11:50:00+00:00",
    "map": {
      "title": "Ground floor",
      "status": "published",
      "doc": {
        "schema": 1,
        "image": {
          "attachment_id": 0,
          "width": 1600,
          "height": 1000,
          "alt": "Ground floor plan"
        },
        "settings": {
          "general": {
            "responsive": true
          },
          "tooltips": {
            "enabled": true,
            "trigger": "hover",
            "sticky": false,
            "constrain": true,
            "animation": "fade"
          },
          "effects": {
            "pageload": "none"
          },
          "zoom": {
            "enabled": false,
            "max": 4.0,
            "buttons": true,
            "wheel": "ctrl",
            "fullscreen": false
          },
          "list": {
            "enabled": false,
            "position": "right",
            "search": true,
            "title": ""
          }
        },
        "objects": [
          {
            "id": "o_3f9a1c2e",
            "type": "spot",
            "name": "Reception",
            "geometry": {
              "x": 42.5,
              "y": 61.25,
              "w": 3.0
            },
            "style": {
              "default": {
                "fill": "#1976d2",
                "fill_opacity": 0.4,
                "stroke": "#ffffff",
                "stroke_opacity": 1.0,
                "stroke_width": 0.0,
                "radius": 4.0,
                "opacity": 1.0,
                "icon": "pin",
                "icon_color": "#ffffff",
                "shadow": false
              },
              "hover": []
            },
            "action": {
              "type": "none",
              "new_tab": false,
              "url": "",
              "event": ""
            },
            "tooltip": {
              "enabled": true,
              "position": "auto",
              "width": 260,
              "offset_x": 0.0,
              "offset_y": 0.0,
              "content": "<p>Reception desk, open 8:00 to 18:00.</p>"
            },
            "a11y": {
              "label": "Reception",
              "description": ""
            },
            "visible": true,
            "locked": false,
            "group": "",
            "ext": []
          }
        ],
        "groups": [],
        "ext": []
      }
    },
    "image": {
      "filename": "ground-floor.png",
      "url": "https://your-site.example/wp-content/uploads/2026/11/ground-floor.png",
      "width": 1600,
      "height": 1000,
      "alt": "Ground floor plan"
    }
  },
  "meta": {
    "filename": "ground-floor.image-map.json"
  }
}

Field	Type	Meaning
`data.format`	`string`	Always `plugixa-image-map`
`data.format_version`	`integer`	The file format, `1`
`data.exported_at`	`string`	ISO 8601 datetime, UTC
`data.map`	`object`	`title`, `status` and the document. `doc.image.attachment_id` is always `0`: an id means nothing on another site
`data.image`	`object\|null`	The picture, described by file name, URL, size and alt text so the importing site can find its own copy. `null` when the map has none
`meta.filename`	`string`	A file name made from the title

Save data (not the whole response) as the file. The picture itself is not included: upload it to the other site’s Media Library before importing. See Import and export.

Errors

Status	Code	When
`404`	`plugixa_image_map_not_found`	No map with that id, or the map is in the trash.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/export" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/export');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-image-map/v1/maps/12/export', {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data, meta } = await response.json();