SEO Projects

See the List of your SEO Projects with number of SEO reports per each of the Projects and their results
Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.


List
See the list of all your Projects

API endpoint:

GET 
https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects


Request example: 

curl --location --request GET 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'


Response example: 


                    {
  "data": [
    {
      "id": 6,
      "domain": "example.com",
      "privacy": 1,
      "email": null,
      "password": false,
      "exclude_bots": 1,
      "exclude_ips": null,
      "created_at": "2023-08-02T00:47:15.000000Z",
      "updated_at": "2023-08-02T00:47:15.000000Z"
    },
    {
      "id": 6,
      "domain": "wordpress.com",
      "privacy": 1,
      "email": null,
      "password": false,
      "exclude_bots": 1,
      "exclude_ips": null,
      "created_at": "2023-08-02T00:47:15.000000Z",
      "updated_at": "2023-08-02T00:47:15.000000Z"
    },
    {
      "id": 6,
      "domain": "wikipedia.org",
      "privacy": 1,
      "email": null,
      "password": false,
      "exclude_bots": 1,
      "exclude_ips": null,
      "created_at": "2023-08-02T00:47:15.000000Z",
      "updated_at": "2023-08-02T00:47:15.000000Z"
    }
  ],
  "links": {
    "first": "https://webzebder.com/api/v1/websites?search_by=domain&sort_by=id&sort=desc&per_page=10&page=1",
    "last": "https://webzebder.com/api/v1/websites?search_by=domain&sort_by=id&sort=desc&per_page=10&page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://webzebder.com/api/v1/websites?search_by=domain&sort_by=id&sort=desc&per_page=10&page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://webzebder.com/api/v1/websites",
    "per_page": 10,
    "to": 1,
    "total": 1
  },
  "status": 200
}


The sample aboove have threee Projects in it Namely: example.com, wikipedia.org, wordpress.com and




You can customize the API by adding this Parameters

Parameter
Type
Description
search
optional string
The search query.
sort_by
optional string
Sort by. Possible values are: created_at for Date created, project for Name. Defaults to: created_at.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 100.


Request example: 

search
curl --location --request GET 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects?search=example'
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Note: search only search for Project Name


sort_by
curl --location --request GET 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects?sort_by=created_at'
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'


sort
curl --location --request GET 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects?sort=desc'
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'


per_page
curl --location --request GET 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects?per_page=25'
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'


You can combine it e.g
curl --location --request GET 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects?search=good&sort_by=created_at&sort=desc&per_page=25'
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'


This Explains:
 search from projects where name has good, sort by date_created, display
in descending order and paginate by 25 results per page




Delete a project
Delete a Project from you projects list

API endpoint:

DELETE 
https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects/{project}
Where {project} is the Project Name e.g. wikipedia.org


Request example: 

curl --location --request DELETE 'https://website-690dc6c1.businessandfamilylawyers.com/api/v1/projects/{project}' \
--header 'Authorization: Bearer {api_key}'