Skip to content

List import activity

Open .md

GET/v1/api/store/{team_slug}/source-imports/activity

v1Operation ID v1_public_source_imports_activity_index

Lists the Import Portal's import activity, newest first unless you ask for sort=oldest, with paging by cursor. Pass meta.next_cursor as cursor to read the next page. The answer is plain JSON, {data, meta}, not the usual {success, status, data} envelope.

CSV events are the Import Portal's CSV imports of customers, vendors and products, once finished: import_completed, import_partial_completed or import_failed, with counts. You see each kind only if you can import it. Service pricing uploads are not in this feed; list them with GET /v1/api/store/{team_slug}/imports.

Permission

Any member who can import some kind of record.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Query parameters

  • sourcestring
    • One of: "all", "csv"
    • Default "all"
    • Example all
  • sortstring
    • One of: "newest", "oldest"
    • Default "newest"
    • Example newest
  • limitinteger

    Events per page. Below 1 or not a number reads as 50; above 100 reads as 100.

    • Default 50
    • Minimum 1
    • Maximum 100
  • cursorstring

    The previous page's meta.next_cursor. An invalid cursor is ignored, and you get the first page.

Request body

This operation takes no request body.

Response

200A page of events.

  • dataarray of objectsrequired
    Fields of each item (9)
      • Always "csv"
    • countsobject

      Entity and source-row counts: entity_count and source_row_count, then submitted_, imported_, failed_, not_processed_, unresolved_, removed_, already_existing_, preflight_blocked_, excluded_ and pending_ each with entity_count and source_row_count. Left out when the import could not be verified.

    • detailstring

      For example "2 imported · 0 need attention".

      • One of: "customer", "vendor", "simple_product", "variant_product"
    • idstring

      csv: and the import's receipt_id.

    • messagestring

      "CSV import completed", "Some entries were imported" or "No entries were imported" ("CSV import could not be verified" when YoPrint stopped the import for a failed integrity check).

    • The Import Portal CSV import's id (csv-...).

    • timestampstring (date-time)

      When the import finished.

    • typestring
      • One of: "import_completed", "import_partial_completed", "import_failed"
  • metaobjectrequired
    Child fields (3)

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

    When
    You can't import anything (a plain {"message": "Insufficient Permission"} body, not the usual envelope).
    Fix
    Ask a team admin.
  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

  • Unrecognized source or sort values are treated as their defaults.